blob: 57007d07b83c7e74eb24ac98f1e402dc54b73e7d [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -05001
2
3
4
cristy29dc8652015-05-12 16:26:21 +00005<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +00006<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +00007<head>
Cristy594d2772015-11-15 10:47:42 -05008 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
cristy29f2c972015-07-28 13:37:46 +00009 <title>ImageMagick: Command-line Options</title>
Cristy594d2772015-11-15 10:47:42 -050010 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
11 <meta name="application-name" content="ImageMagick"/>
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
13 <meta name="application-url" content="http://www.imagemagick.org"/>
14 <meta name="generator" content="PHP"/>
15 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
16 <meta name="rating" content="GENERAL"/>
17 <meta name="robots" content="INDEX, FOLLOW"/>
18 <meta name="generator" content="ImageMagick Studio LLC"/>
19 <meta name="author" content="ImageMagick Studio LLC"/>
20 <meta name="revisit-after" content="2 DAYS"/>
21 <meta name="resource-type" content="document"/>
22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"/>
23 <meta name="distribution" content="Global"/>
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
25 <link rel="icon" href="../images/wand.png"/>
26 <link rel="shortcut icon" href="../images/wand.ico"/>
27 <link rel="stylesheet" href="../css/magick.html"/>
cristyad41c0c2012-10-31 00:49:28 +000028</head>
cristyd2432012015-05-04 23:15:15 +000029<body>
cristyad41c0c2012-10-31 00:49:28 +000030<div class="main">
cristyd2432012015-05-04 23:15:15 +000031<div class="magick-masthead">
32 <div class="container">
Cristy594d2772015-11-15 10:47:42 -050033 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
34 style="display:block"
35 data-ad-client="ca-pub-3129977114552745"
36 data-ad-slot="6345125851"
37 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000038 <script>
Cristy542697a2015-10-12 20:10:32 -040039 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000040 </script>
cristyd2432012015-05-04 23:15:15 +000041 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000042 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +000043 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000044 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
45 <a class="magick-nav-item active" href="command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +000046 <a class="magick-nav-item " href="resources.html">Resources</a>
47 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +000048 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +000049 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000050 </nav>
51 </div>
52</div>
53<div class="container">
Cristy882d9f42015-10-29 16:48:39 -040054<div class="magick-header">
Cristy594d2772015-11-15 10:47:42 -050055<p class="text-center"><a href="command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a><a href="command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a><a href="command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a><a href="command-line-options.html#adjoin">&#x2011;adjoin</a><a href="command-line-options.html#affine">&#x2011;affine</a><a href="command-line-options.html#alpha">&#x2011;alpha</a><a href="command-line-options.html#annotate">&#x2011;annotate</a><a href="command-line-options.html#antialias">&#x2011;antialias</a><a href="command-line-options.html#append">&#x2011;append</a><a href="command-line-options.html#attenuate">&#x2011;attenuate</a><a href="command-line-options.html#authenticate">&#x2011;authenticate</a><a href="command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a><a href="command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a><a href="command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a><a href="command-line-options.html#backdrop">&#x2011;backdrop</a><a href="command-line-options.html#background">&#x2011;background</a><a href="command-line-options.html#bench">&#x2011;bench</a><a href="command-line-options.html#bias">&#x2011;bias</a><a href="command-line-options.html#black-point-compensation">&#x2011;black&#x2011;point&#x2011;compensation</a><a href="command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a><a href="command-line-options.html#blend">&#x2011;blend</a><a href="command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a><a href="command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a><a href="command-line-options.html#blur">&#x2011;blur</a><a href="command-line-options.html#border">&#x2011;border</a><a href="command-line-options.html#bordercolor">&#x2011;bordercolor</a><a href="command-line-options.html#borderwidth">&#x2011;borderwidth</a><a href="command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a><a href="command-line-options.html#cache">&#x2011;cache</a><a href="command-line-options.html#canny">&#x2011;canny</a><a href="command-line-options.html#caption">&#x2011;caption</a><a href="command-line-options.html#cdl">&#x2011;cdl</a><a href="command-line-options.html#channel">&#x2011;channel</a><a href="command-line-options.html#charcoal">&#x2011;charcoal</a><a href="command-line-options.html#chop">&#x2011;chop</a><a href="command-line-options.html#clamp">&#x2011;clamp</a><a href="command-line-options.html#clip">&#x2011;clip</a><a href="command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a><a href="command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a><a href="command-line-options.html#clone">&#x2011;clone</a><a href="command-line-options.html#clut">&#x2011;clut</a><a href="command-line-options.html#coalesce">&#x2011;coalesce</a><a href="command-line-options.html#colorize">&#x2011;colorize</a><a href="command-line-options.html#colormap">&#x2011;colormap</a><a href="command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a><a href="command-line-options.html#colors">&#x2011;colors</a><a href="command-line-options.html#colorspace">&#x2011;colorspace</a><a href="command-line-options.html#combine">&#x2011;combine</a><a href="command-line-options.html#comment">&#x2011;comment</a><a href="command-line-options.html#compare">&#x2011;compare</a><a href="command-line-options.html#complex">&#x2011;complex</a><a href="command-line-options.html#compose">&#x2011;compose</a><a href="command-line-options.html#composite">&#x2011;composite</a><a href="command-line-options.html#compress">&#x2011;compress</a><a href="command-line-options.html#connected-components">&#x2011;connected&#x2011;components</a><a href="command-line-options.html#contrast">&#x2011;contrast</a><a href="command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a><a href="command-line-options.html#convolve">&#x2011;convolve</a><a href="command-line-options.html#copy">&#x2011;copy</a><a href="command-line-options.html#crop">&#x2011;crop</a><a href="command-line-options.html#cycle">&#x2011;cycle</a><a href="command-line-options.html#debug">&#x2011;debug</a><a href="command-line-options.html#decipher">&#x2011;decipher</a><a href="command-line-options.html#deconstruct">&#x2011;deconstruct</a><a href="command-line-options.html#define">&#x2011;define</a><a href="command-line-options.html#delay">&#x2011;delay</a><a href="command-line-options.html#delete">&#x2011;delete</a><a href="command-line-options.html#density">&#x2011;density</a><a href="command-line-options.html#depth">&#x2011;depth</a><a href="command-line-options.html#descend">&#x2011;descend</a><a href="command-line-options.html#deskew">&#x2011;deskew</a><a href="command-line-options.html#despeckle">&#x2011;despeckle</a><a href="command-line-options.html#direction">&#x2011;direction</a><a href="command-line-options.html#displace">&#x2011;displace</a><a href="command-line-options.html#display">&#x2011;display</a><a href="command-line-options.html#dispose">&#x2011;dispose</a><a href="command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a><a href="command-line-options.html#dissolve">&#x2011;dissolve</a><a href="command-line-options.html#distort">&#x2011;distort</a><a href="command-line-options.html#distribute-cache">&#x2011;distribute&#x2011;cache</a><a href="command-line-options.html#dither">&#x2011;dither</a><a href="command-line-options.html#draw">&#x2011;draw</a><a href="command-line-options.html#duplicate">&#x2011;duplicate</a><a href="command-line-options.html#edge">&#x2011;edge</a><a href="command-line-options.html#emboss">&#x2011;emboss</a><a href="command-line-options.html#encipher">&#x2011;encipher</a><a href="command-line-options.html#encoding">&#x2011;encoding</a><a href="command-line-options.html#endian">&#x2011;endian</a><a href="command-line-options.html#enhance">&#x2011;enhance</a><a href="command-line-options.html#equalize">&#x2011;equalize</a><a href="command-line-options.html#evaluate">&#x2011;evaluate</a><a href="command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a><a href="command-line-options.html#extent">&#x2011;extent</a><a href="command-line-options.html#extract">&#x2011;extract</a><a href="command-line-options.html#family">&#x2011;family</a><a href="command-line-options.html#features">&#x2011;features</a><a href="command-line-options.html#fft">&#x2011;fft</a><a href="command-line-options.html#fill">&#x2011;fill</a><a href="command-line-options.html#filter">&#x2011;filter</a><a href="command-line-options.html#flatten">&#x2011;flatten</a><a href="command-line-options.html#flip">&#x2011;flip</a><a href="command-line-options.html#floodfill">&#x2011;floodfill</a><a href="command-line-options.html#flop">&#x2011;flop</a><a href="command-line-options.html#font">&#x2011;font</a><a href="command-line-options.html#foreground">&#x2011;foreground</a><a href="command-line-options.html#format">&#x2011;format</a><a href="command-line-options.html#format_identify_">&#x2011;format[identify]</a><a href="command-line-options.html#frame">&#x2011;frame</a><a href="command-line-options.html#frame_import_">&#x2011;frame[import]</a><a href="command-line-options.html#function">&#x2011;function</a><a href="command-line-options.html#fuzz">&#x2011;fuzz</a><a href="command-line-options.html#fx">&#x2011;fx</a><a href="command-line-options.html#gamma">&#x2011;gamma</a><a href="command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a><a href="command-line-options.html#geometry">&#x2011;geometry</a><a href="command-line-options.html#gravity">&#x2011;gravity</a><a href="command-line-options.html#grayscale">&#x2011;grayscale</a><a href="command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a><a href="command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a><a href="command-line-options.html#help">&#x2011;help</a><a href="command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a><a href="command-line-options.html#hough-lines">&#x2011;hough&#x2011;lines</a><a href="command-line-options.html#iconGeometry">&#x2011;iconGeometry</a><a href="command-line-options.html#iconic">&#x2011;iconic</a><a href="command-line-options.html#identify">&#x2011;identify</a><a href="command-line-options.html#ift">&#x2011;ift</a><a href="command-line-options.html#immutable">&#x2011;immutable</a><a href="command-line-options.html#implode">&#x2011;implode</a><a href="command-line-options.html#insert">&#x2011;insert</a><a href="command-line-options.html#intensity">&#x2011;intensity</a><a href="command-line-options.html#intent">&#x2011;intent</a><a href="command-line-options.html#interlace">&#x2011;interlace</a><a href="command-line-options.html#interpolate">&#x2011;interpolate</a><a href="command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a><a href="command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a><a href="command-line-options.html#kerning">&#x2011;kerning</a><a href="command-line-options.html#kuwahara">&#x2011;kuwahara</a><a href="command-line-options.html#label">&#x2011;label</a><a href="command-line-options.html#lat">&#x2011;lat</a><a href="command-line-options.html#layers">&#x2011;layers</a><a href="command-line-options.html#level">&#x2011;level</a><a href="command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a><a href="command-line-options.html#limit">&#x2011;limit</a><a href="command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a><a href="command-line-options.html#linewidth">&#x2011;linewidth</a><a href="command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a><a href="command-line-options.html#list">&#x2011;list</a><a href="command-line-options.html#log">&#x2011;log</a><a href="command-line-options.html#loop">&#x2011;loop</a><a href="command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a><a href="command-line-options.html#magnify">&#x2011;magnify</a><a href="command-line-options.html#map">&#x2011;map</a><a href="command-line-options.html#map_stream_">&#x2011;map[stream]</a><a href="command-line-options.html#mask">&#x2011;mask</a><a href="command-line-options.html#mattecolor">&#x2011;mattecolor</a><a href="command-line-options.html#median">&#x2011;median</a><a href="command-line-options.html#mean-shift">&#x2011;mean&#x2011;shift</a><a href="command-line-options.html#metric">&#x2011;metric</a><a href="command-line-options.html#mode">&#x2011;mode</a><a href="command-line-options.html#modulate">&#x2011;modulate</a><a href="command-line-options.html#moments">&#x2011;moments</a><a href="command-line-options.html#monitor">&#x2011;monitor</a><a href="command-line-options.html#monochrome">&#x2011;monochrome</a><a href="command-line-options.html#morph">&#x2011;morph</a><a href="command-line-options.html#morphology">&#x2011;morphology</a><a href="command-line-options.html#mosaic">&#x2011;mosaic</a><a href="command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a><a href="command-line-options.html#name">&#x2011;name</a><a href="command-line-options.html#negate">&#x2011;negate</a><a href="command-line-options.html#noise">&#x2011;noise</a><a href="command-line-options.html#normalize">&#x2011;normalize</a><a href="command-line-options.html#opaque">&#x2011;opaque</a><a href="command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a><a href="command-line-options.html#orient">&#x2011;orient</a><a href="command-line-options.html#page">&#x2011;page</a><a href="command-line-options.html#paint">&#x2011;paint</a><a href="command-line-options.html#path">&#x2011;path</a><a href="command-line-options.html#pause_animate_">&#x2011;pause[animate]</a><a href="command-line-options.html#pause_import_">&#x2011;pause[import]</a><a href="command-line-options.html#perceptible">&#x2011;perceptible</a><a href="command-line-options.html#ping">&#x2011;ping</a><a href="command-line-options.html#pointsize">&#x2011;pointsize</a><a href="command-line-options.html#polaroid">&#x2011;polaroid</a><a href="command-line-options.html#poly">&#x2011;poly</a><a href="command-line-options.html#posterize">&#x2011;posterize</a><a href="command-line-options.html#precision">&#x2011;precision</a><a href="command-line-options.html#preview">&#x2011;preview</a><a href="command-line-options.html#print">&#x2011;print</a><a href="command-line-options.html#process">&#x2011;process</a><a href="command-line-options.html#profile">&#x2011;profile</a><a href="command-line-options.html#quality">&#x2011;quality</a><a href="command-line-options.html#quantize">&#x2011;quantize</a><a href="command-line-options.html#quiet">&#x2011;quiet</a><a href="command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a><a href="command-line-options.html#raise">&#x2011;raise</a><a href="command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a><a href="command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a><a href="command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a><a href="command-line-options.html#region">&#x2011;region</a><a href="command-line-options.html#remap">&#x2011;remap</a><a href="command-line-options.html#remote">&#x2011;remote</a><a href="command-line-options.html#render">&#x2011;render</a><a href="command-line-options.html#repage">&#x2011;repage</a><a href="command-line-options.html#resample">&#x2011;resample</a><a href="command-line-options.html#resize">&#x2011;resize</a><a href="command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a><a href="command-line-options.html#reverse">&#x2011;reverse</a><a href="command-line-options.html#roll">&#x2011;roll</a><a href="command-line-options.html#rotate">&#x2011;rotate</a><a href="command-line-options.html#sample">&#x2011;sample</a><a href="command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a><a href="command-line-options.html#scale">&#x2011;scale</a><a href="command-line-options.html#scene">&#x2011;scene</a><a href="command-line-options.html#screen">&#x2011;screen</a><a href="command-line-options.html#seed">&#x2011;seed</a><a href="command-line-options.html#segment">&#x2011;segment</a><a href="command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a><a href="command-line-options.html#separate">&#x2011;separate</a><a href="command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a><a href="command-line-options.html#set">&#x2011;set</a><a href="command-line-options.html#shade">&#x2011;shade</a><a href="command-line-options.html#shadow">&#x2011;shadow</a><a href="command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a><a href="command-line-options.html#sharpen">&#x2011;sharpen</a><a href="command-line-options.html#shave">&#x2011;shave</a><a href="command-line-options.html#shear">&#x2011;shear</a><a href="command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a><a href="command-line-options.html#silent">&#x2011;silent</a><a href="command-line-options.html#similarity-threshold">&#x2011;similarity&#x2011;threshold</a><a href="command-line-options.html#size">&#x2011;size</a><a href="command-line-options.html#sketch">&#x2011;sketch</a><a href="command-line-options.html#smush">&#x2011;smush</a><a href="command-line-options.html#snaps">&#x2011;snaps</a><a href="command-line-options.html#solarize">&#x2011;solarize</a><a href="command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a><a href="command-line-options.html#splice">&#x2011;splice</a><a href="command-line-options.html#spread">&#x2011;spread</a><a href="command-line-options.html#statistic">&#x2011;statistic</a><a href="command-line-options.html#stegano">&#x2011;stegano</a><a href="command-line-options.html#stereo">&#x2011;stereo</a><a href="command-line-options.html#storage-type">&#x2011;storage&#x2011;type</a><a href="command-line-options.html#stretch">&#x2011;stretch</a><a href="command-line-options.html#strip">&#x2011;strip</a><a href="command-line-options.html#stroke">&#x2011;stroke</a><a href="command-line-options.html#strokewidth">&#x2011;strokewidth</a><a href="command-line-options.html#style">&#x2011;style</a><a href="command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a><a href="command-line-options.html#swap">&#x2011;swap</a><a href="command-line-options.html#swirl">&#x2011;swirl</a><a href="command-line-options.html#synchronize">&#x2011;synchronize</a><a href="command-line-options.html#taint">&#x2011;taint</a><a href="command-line-options.html#text-font">&#x2011;text&#x2011;font</a><a href="command-line-options.html#texture">&#x2011;texture</a><a href="command-line-options.html#threshold">&#x2011;threshold</a><a href="command-line-options.html#thumbnail">&#x2011;thumbnail</a><a href="command-line-options.html#tile">&#x2011;tile</a><a href="command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a><a href="command-line-options.html#tint">&#x2011;tint</a><a href="command-line-options.html#title">&#x2011;title</a><a href="command-line-options.html#transform">&#x2011;transform</a><a href="command-line-options.html#transparent">&#x2011;transparent</a><a href="command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a><a href="command-line-options.html#transpose">&#x2011;transpose</a><a href="command-line-options.html#transverse">&#x2011;transverse</a><a href="command-line-options.html#treedepth">&#x2011;treedepth</a><a href="command-line-options.html#trim">&#x2011;trim</a><a href="command-line-options.html#type">&#x2011;type</a><a href="command-line-options.html#undercolor">&#x2011;undercolor</a><a href="command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a><a href="command-line-options.html#units">&#x2011;units</a><a href="command-line-options.html#unsharp">&#x2011;unsharp</a><a href="command-line-options.html#update">&#x2011;update</a><a href="command-line-options.html#verbose">&#x2011;verbose</a><a href="command-line-options.html#version">&#x2011;version</a><a href="command-line-options.html#view">&#x2011;view</a><a href="command-line-options.html#vignette">&#x2011;vignette</a><a href="command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a><a href="command-line-options.html#visual">&#x2011;visual</a><a href="command-line-options.html#watermark">&#x2011;watermark</a><a href="command-line-options.html#wave">&#x2011;wave</a><a href="command-line-options.html#weight">&#x2011;weight</a><a href="command-line-options.html#white-point">&#x2011;white&#x2011;point</a><a href="command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a><a href="command-line-options.html#window">&#x2011;window</a><a href="command-line-options.html#window-group">&#x2011;window&#x2011;group</a><a href="command-line-options.html#write">&#x2011;write</a> </p>
Cristy882d9f42015-10-29 16:48:39 -040056
57<p class="lead magick-description">Below is list of command-line options recognized by the ImageMagick <a href="command-line-tools.html">command-line tools</a>. If you want a description of a particular option, click on the option name in the navigation bar above and you will go right to it. Unless otherwise noted, each option is recognized by the commands: <a href="convert.html">convert</a> and <a href="mogrify.html">mogrify</a>.</p>
58
59<div style="margin: auto;">
60 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
61</div>
62
63<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
64
65<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
66defaults to 1.</p>
67
68<div style="margin: auto;">
69 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
70</div>
71
72<p class="magick-description">Resize the image using data-dependent triangulation.</p>
73
74<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="command-line-options.html#adaptive-resize">-adaptive-resize</a>
Cristy594d2772015-11-15 10:47:42 -050075option defaults to data-dependent triangulation. Use the <a
76href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
77Offsets, if present in the geometry string, are ignored, and the <a
78href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040079
80<div style="margin: auto;">
81 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
82</div>
83
84<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
85
86<p>A Gaussian operator of the given radius and standard deviation
87(<var>sigma</var>) is used. If <var>sigma</var> is not given it
88defaults to 1.</p>
89
90<div style="margin: auto;">
91 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
92</div>
93
94<p class="magick-description">Join images into a single multi-image file.</p>
95
96<p>This option is enabled by default. An attempt is made to save all images of
97an image sequence into the given output file. However, some formats, such as
98JPEG and PNG, do not support more than one image per file, and in that case
99ImageMagick is forced to write each image as a separate file. As such, if
100more than one image needs to be written, the filename given is modified by
101adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
102make distinct names for each image. </p>
103
104<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
105separate files, whether or not the file format allows multiple images per file
106(for example, GIF, MIFF, and TIFF). </p>
107
108<p>Including a C-style integer format string in the output filename will
109automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
110where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
111strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
112who have used the standard <code>printf()</code>' C-library function. As an
113example, the command</p>
114
115<pre>
116convert logo: rose: -morph 15 my%02dmorph.jpg
117</pre>
118
119<p>will create a sequence of 17 images (the two given plus 15 more created by
120<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
121my02morph.jpg, ..., my16morph.jpg. </p>
122
123<p>In summary, ImageMagick tries to write all images to one file, but will
124save to multiple files, if any of the following conditions exist...</p>
125<ol>
126<li>the output image's file format does not allow multi-image files,</li>
127<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
128<li>a printf() integer format string (eg: "%d") is present in the output
129 filename.</li>
130</ol>
131
132
133<div style="margin: auto;">
134 <h3 class="magick-header"><a id="affine"></a>-affine
135 <var>s<sub>x</sub></var>,<var>r<sub>x</sub></var>,<var>r<sub>y</sub></var>,<var>s<sub>y</sub></var>[,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>]</h3>
136</div>
137
138<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
139
Cristy594d2772015-11-15 10:47:42 -0500140<p>This option sets a transformation matrix, for use by subsequent <a
141href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
Cristy882d9f42015-10-29 16:48:39 -0400142
143<p>The matrix entries are entered as comma-separated numeric values either in
144quotes or without spaces. </p>
145
146<p>Internally, the transformation matrix has 3x3 elements, but three of them
147are omitted from the input because they are constant. The new (transformed)
148coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
149position (<var>x</var>, <var>y</var>) in the original
150image are calculated using the following matrix equation.</p>
151
Cristy594d2772015-11-15 10:47:42 -0500152<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400153
154<p> The size of the resulting image is that of the smallest rectangle that
155contains the transformed source image. The parameters
156<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
157subsequently shift the image pixels so that those that are moved out of the
158image area are cut off.</p>
159
160<p>The transformation matrix complies with the left-handed pixel coordinate
161system: positive <var>x</var> and <var>y</var> directions
162are rightward and downward, resp.; positive rotation is clockwise.</p>
163
164<p> If the translation coefficients <var>t<sub>x</sub></var> and
165<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
166four parameters suffice for rotation and scaling without translation.</p>
167
168<p>Scaling by the factors <var>s<sub>x</sub></var> and
169<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
170respectively, is accomplished with the following.</p>
171
Cristy594d2772015-11-15 10:47:42 -0500172<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
173href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400174information </p>
175
176
177<pre>
178-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
179</pre>
180
181<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
182
183<pre>
184-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
185</pre>
186
187<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
188<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
189= sin(<var>a</var>), and using the following.</p>
190
191<pre>
192-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
193</pre>
194
Cristy594d2772015-11-15 10:47:42 -0500195<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
196transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
197>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400198of the individual transformations.</p>
199
200<p>An attempt is made to detect near-singular transformation matrices. If the
201matrix determinant has a sufficiently small absolute value it is rejected.</p>
202
203<div style="margin: auto;">
204 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
205</div>
206
207<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
208
209<p>Used to set a flag on an image indicating whether or not to use existing alpha
210channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <var>type</var> from the list below.</p>
211
212<dl class="dl-horizontal">
213 <dt>Activate</dt>
214 <dd>
215 Enable the image's transparency channel. Note normally Set
216 should be used instead of this, unless you specifically need to
217 preserve existing (but specifically turned Off) transparency
218 channel. </dd>
219
220 <dt>Associate</dt>
221 <dd>
222 associate the alpha channel with the image.</dd>
223
224 <dt>Deactivate</dt>
225 <dd>
226 Disables the image's transparency channel. Does not delete or change the
227 existing data, just turns off the use of that data.</dd>
228
229 <dt>Disassociate</dt>
230 <dd>
231 disassociate the alpha channel from the image.</dd>
232
233 <dt>Set</dt>
234 <dd>
235 Activates the alpha/matte channel. If it was previously turned off
236 then it also resets the channel to opaque. If the image already had
237 the alpha channel turned on, it will have no effect.</dd>
238
239 <dt>Opaque</dt>
240 <dd>
241 Enables the alpha/matte channel and forces it to be fully opaque.
242 </dd>
243
244 <dt>Transparent</dt>
245 <dd>
246 Activates the alpha/matte channel and forces it to be fully
247 transparent. This effectively creates a fully transparent image the
248 same size as the original and with all its original RGB data still
249 intact, but fully transparent. </dd>
250
251 <dt>Extract</dt>
252 <dd>
253 Copies the alpha channel values into all the color channels and turns
254 'Off' the the image's transparency, so as to generate
255 a gray-scale mask of the image's shape. The alpha channel data is left
256 intact just deactivated. This is the inverse of 'Copy'.
257 </dd>
258
259 <dt>Copy</dt>
260 <dd>
261 Turns 'On' the alpha/matte channel, then copies the
262 gray-scale intensity of the image, into the alpha channel, converting
263 a gray-scale mask into a transparent shaped mask ready to be colored
264 appropriately. The color channels are not modified. </dd>
265
266 <dt>Shape</dt>
267 <dd>
268 As per 'Copy' but also colors the resulting shape mask with
269 the current background color. That is the RGB color channels is
270 replaced, with appropriate alpha shape.
271 </dd>
272
273 <dt>Remove</dt>
274 <dd>
275 Composite the image over the background color.
276 </dd>
277
278 <dt>Background</dt>
279 <dd>
280 Set any fully-transparent pixel to the background color, while leaving
281 it fully-transparent. This can make some image file formats, such as
282 PNG, smaller as the RGB values of transparent pixels are more uniform,
283 and thus can compress better.
284 </dd>
285</dl>
286
287<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500288same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
289>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
290Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400291
292
293<div style="margin: auto;">
294 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500295 -annotate <var>degrees</var> <var>text</var><br />
296 -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 -0400297</div>
298
299<p class="magick-description">Annotate an image with text</p>
300
301<p>This is a convenience for annotating an image with text. For more precise
302control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
303
304
305<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500306control 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 -0400307
308<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
309or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
310direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
311convention once it is realized that the positive <var>y</var>–direction is
312conventionally considered to be <var>downward</var> for images.)</p>
313
314<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
315equation.</p>
316
Cristy594d2772015-11-15 10:47:42 -0500317<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400318
319<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
320bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500321probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400322case leads to nice results.</p>
323
324<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
325is of the form '@mytext.txt', the text is read from the file
326<code>mytext.txt</code>. Text in a file is taken literally; no embedded
327formatting characters are recognized.</p>
328
329<div style="margin: auto;">
330 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
331</div>
332
333<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
334
335<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
336drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
337antialiasing edge pixels. This will then reduce the number of colors added to
338an image to just the colors being directly drawn. That is, no mixed colors
339are added when drawing such objects. </p>
340
341<div style="margin: auto;">
342 <h3 class="magick-header"><a id="append"></a>-append</h3>
343</div>
344
345<p class="magick-description">Join current images vertically or horizontally.</p>
346
347<p>This option creates a single longer image, by joining all the current
348images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
349stack images left-to-right. </p>
350
351<p>If they are not of the same width, narrower images are padded with the
352current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500353position relative to each other can be controlled by the current <a
354href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400355
356
357<div style="margin: auto;">
358 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
359</div>
360
361<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
362
363<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
364
365<div style="margin: auto;">
366 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
367</div>
368
369<p class="magick-description">Decrypt a PDF with a password.</p>
370
371<p>Use this option to supply a <var>password</var> for decrypting
372a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
373encrypting using the MSC API is not supported.</p>
374
375<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
376and <a href="command-line-options.html#decipher">-decipher</a>. </p>
377
378
379<div style="margin: auto;">
380 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
381</div>
382
383<p class="magick-description">Automagically adjust gamma level of image.</p>
384
Cristy594d2772015-11-15 10:47:42 -0500385<p>This calculates the mean values of an image, then applies a calculated <a
386href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400387image it will get a have a value of 50%. </p>
388
389<p>This means that any solid 'gray' image becomes 50% gray. </p>
390
391<p>This works well for real-life images with little or no extreme dark and
392light areas, but tend to fail for images with large amounts of bright sky or
393dark shadows. It also does not work well for diagrams or cartoon like images.
394</p>
395
Cristy594d2772015-11-15 10:47:42 -0500396<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400397'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500398values is used and modified. As the default <a href="command-line-options.html#channel"
399>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400400together by the same gamma value, preserving colors. </p>
401
402
403
404<div style="margin: auto;">
405 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
406</div>
407
408<p class="magick-description">Automagically adjust color levels of image.</p>
409
410<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500411minimum and maximum color values in the image and then applies a <a
412href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400413values. </p>
414
415<p>The operator is not typically used for real-life images, image scans, or
416JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500417for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400418right operator to use for color stretching gradient images being used to
419generate Color lookup tables, distortion maps, or other 'mathematically'
420defined images. </p>
421
Cristy594d2772015-11-15 10:47:42 -0500422<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
423href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
424>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
425problems that these operators may have. That is <a href="command-line-options.html#auto-level"
426>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400427
Cristy594d2772015-11-15 10:47:42 -0500428<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400429special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500430which color values are used and modified. As the default <a
431href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400432'<var>sync</var>' ensures that the color channels will are modified
433together by the same gamma value, preserving colors, and ignoring
434transparency. </p>
435
436
437<div style="margin: auto;">
438 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
439</div>
440
441<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
442
443<p>This operator reads and resets the EXIF image profile setting 'Orientation'
444and then performs the appropriate 90 degree rotation on the image to orient
445the image, for correct viewing. </p>
446
447<p>This EXIF profile setting is usually set using a gravity sensor in digital
448camera, however photos taken directly downward or upward may not have an
449appropriate value. Also images that have been orientation 'corrected' without
450reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500451result. If the EXIF profile was previously stripped, the <a
452href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400453
454
455<div style="margin: auto;">
456 <h3 class="magick-header"><a id="average"></a>-average</h3>
457</div>
458
459<p class="magick-description">Average a set of images.</p>
460
461<p>An error results if the images are not identically sized.</p>
462
463
464<div style="margin: auto;">
465 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
466</div>
467
468<p class="magick-description">Display the image centered on a backdrop.</p>
469
470<p>This backdrop covers the entire workstation screen and is useful for hiding
471other X window activity while viewing the image. The color of the backdrop is
472specified as the background color. The color is specified using the format
473described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
474
475<div style="margin: auto;">
476 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
477</div>
478
479<p class="magick-description">Set the background color.</p>
480
Cristy594d2772015-11-15 10:47:42 -0500481<p>The color is specified using the format described under the <a
482href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400483specified or found in the image) is white.</p>
484
485<div style="margin: auto;">
486 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
487</div>
488
489<p class="magick-description">Measure performance.</p>
490
491<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
492consider the following command and its output. Modify the benchmark with the
493-duration to run the benchmark for a fixed number of seconds and -concurrent
494to run the benchmark in parallel (requires the OpenMP feature).</p>
495
496<pre>
Cristy594d2772015-11-15 10:47:42 -0500497-> convert logo: -resize 1000% -bench 5 logo.png
Cristy882d9f42015-10-29 16:48:39 -0400498Performance[4]: 5i 0.875657ips 6.880u 0:05.710
499</pre>
500
501<p>In this example, 5 iterations were completed at 0.875657 iterations per
502second, using 4 threads and 6.88 seconds of the user's allotted time, for
503a total elapsed time of 5.71 seconds.</p>
504
505<div style="margin: auto;">
506 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
507</div>
508
509<p class="magick-description">Add bias when convolving an image.</p>
510
Cristy594d2772015-11-15 10:47:42 -0500511<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 -0400512positive and negative results are relative to the specified bias value. </p>
513
514<p>This is important for non-HDRI compilations of ImageMagick when dealing
515with convolutions that contain negative as well as positive values. This is
516especially the case with convolutions involving high pass filters or edge
517detection. Without an output bias, the negative values are clipped at
518zero.</p>
519
Cristy594d2772015-11-15 10:47:42 -0500520<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 -0400521negative results without clipping to the color value range
522(0..QuantumRange).</p>
523
Cristy594d2772015-11-15 10:47:42 -0500524<p>See the discussion on HDRI implementations of ImageMagick on the page <a
525href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
526about HDRI go the ImageMagick <a
527href="http://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
528<a
529href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400530entry. </p>
531
532<div style="margin: auto;">
533 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
534</div>
535
536<p class="magick-description">Use black point compensation.</p>
537
538<div style="margin: auto;">
539 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
540</div>
541
542<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
543
544<p> The threshold value can be given as a percentage or as an absolute integer
545value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500546desired <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 -0400547
548
549<div style="margin: auto;">
550 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
551</div>
552
553<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
554
555<p>Blend will average the images together ('plus') according to the
556percentages given and each pixels transparency. If only a single percentage
557value is given it sets the weight of the composite or 'source' image, while
558the background image is weighted by the exact opposite amount. That is a
559<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
560'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
561
562
563<div style="margin: auto;">
564 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
565</div>
566
567<p class="magick-description">Set the blue chromaticity primary point.</p>
568
569<div style="margin: auto;">
570 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
571</div>
572
573<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
574
575<div style="margin: auto;">
576
577<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500578 <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 -0400579</div>
580
581<p class="magick-description">Reduce image noise and reduce detail levels.</p>
582
583<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500584<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400585
Cristy594d2772015-11-15 10:47:42 -0500586<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 -0400587
Cristy594d2772015-11-15 10:47:42 -0500588<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400589determines the actual amount of blurring that will take place. </p>
590
Cristy594d2772015-11-15 10:47:42 -0500591<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400592array which will hold the calculated Gaussian distribution. It should be an
593integer. If not given, or set to zero, IM will calculate the largest possible
594radius that will provide meaningful results for the Gaussian distribution.
595</p>
596
Cristy594d2772015-11-15 10:47:42 -0500597<p>The larger the <var >Radius</var> the slower the
598operation is. However too small a <var >Radius</var>, and sever
599aliasing effects may result. As a guideline, <var >Radius</var>
600should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400601times will produce a more accurate result. </p>
602
603<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
604by taking advantage of the separability properties of the distribution. Here
605we apply a single-dimensional Gaussian matrix in the horizontal direction,
606then repeat the process in the vertical direction.</p>
607
608<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
609pixels which are outside the image proper are blurred into the final result.
610</p>
611
612
613<div style="margin: auto;">
614 <h3 class="magick-header">-blur <var>Width</var>[x<var>Height</var>[+<var>Angle</var>]]</h3>
615</div>
616
617<p class="magick-description">Variably blur an image according to the overlay mapping.</p>
618
619<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
620Average (EWA) of the source image, scaled according to the grayscale
621mapping. </p>
622
Cristy594d2772015-11-15 10:47:42 -0500623<p>The ellipse is weighted with sigma set to the given <var>Width</var> and <var >Height</var>. The <var >Height</var>
624defaults to the <var >Width</var> for a normal circular Gaussian
625weighting. The <var >Angle</var> will rotate the ellipse from
Cristy882d9f42015-10-29 16:48:39 -0400626horizontal clock-wise. </p>
627
628<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
629pixels which are outside the image proper are blurred into the final result.
630</p>
631
632
633<div style="margin: auto;">
634 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
635</div>
636
637<p class="magick-description">Surround the image with a border of color. </p>
638
639<p>Set the width and height using the <var>size</var> portion of the
640<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
641ignored. </p>
642
643<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
644
645<dl class="dl-horizontal">
646<dt><var>value</var></dt>
647<dd>value is added to both left/right and top/bottom</dd>
648<dt><var>value-x</var><kbd>x</kbd></dt>
649<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
650<dt><kbd>x</kbd><var>value-y</var></dt>
651<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
652<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
653<dd>value-x is added to left/right and value-y added to top/bottom</dd>
654<dt><var>value-x</var><kbd>x</kbd>0</dt>
655<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
656<dt>0<kbd>x</kbd><var>value-y</var></dt>
657<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
658<dt><var>value</var>%</dt>
659<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
660<dt><var>value-x</var><kbd>x</kbd>%</dt>
661<dd>value-x % of width is added to left/right and to top/bottom</dd>
662<dt>x<var>value-y</var>%</dt>
663<dd>value-y % of height is added to top/bottom and to left/right</dd>
664<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
665<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
666<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
667<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
668<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
669<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
670</dl>
671
Cristy594d2772015-11-15 10:47:42 -0500672<p>Set the border color by preceding with the <a
673href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400674
Cristy594d2772015-11-15 10:47:42 -0500675<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
676href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400677'<code>Over</code>' composition method. It generates an image of the appropriate
678size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
679overlaying the original image in the center of this net image. This means that
680with the default compose method of '<code>Over</code>' any transparent parts may
681be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
682<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
683functionality.</p>
684
685<div style="margin: auto;">
686 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
687</div>
688
689<p class="magick-description">Set the border color.</p>
690
691<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
692
693<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
694
695<div style="margin: auto;">
696 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
697</div>
698
699<p class="magick-description">Set the border width.</p>
700
701<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500702 <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 -0400703</div>
704
705<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
706
707<p>Brightness and Contrast values apply changes to the input image. They are
708not absolute settings. A brightness or contrast value of zero means no change.
709The range of values is -100 to +100 on each. Positive values increase the
710brightness or contrast and negative values decrease the brightness or contrast.
711To control only contrast, set the brightness=0. To control only brightness,
712set contrast=0 or just leave it off.</p>
713
714<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
715apply the brightness and/or contrast change. The default is to apply the same
716transformation to all channels.</p>
717
718<p>Brightness and Contrast arguments are converted to offset and slope of a
719linear transform and applied
720using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
721
722<p>The slope varies from 0 at contrast=-100 to almost vertical at
723contrast=+100. For brightness=0 and contrast=-100, the result are totally
724midgray. For brightness=0 and contrast=+100, the result will approach but
725not quite reach a threshold at midgray; that is the linear transformation
726is a very steep vertical line at mid gray.</p>
727
728<p>Negative slopes, i.e. negating the image, are not possible with this
729function. All achievable slopes are zero or positive.</p>
730
731<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
732at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
733totally white. Similarly, when contrast=0 and brightness=-100, the result is
734totally black.</p>
735
736<p>As the range of values for the arguments are -100 to +100, adding the '%'
737symbol is no different than leaving it off.</p>
738
739<div style="margin: auto;">
740 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
741</div>
742
Cristy594d2772015-11-15 10:47:42 -0500743<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 -0400744
745<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500746 <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 -0400747</div>
748
749<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
750
751<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>
752
753<div style="margin: auto;">
754 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
755</div>
756
757<p class="magick-description">Assign a caption to an image.</p>
758
759<p>This option sets the caption meta-data of an image read in after this
760option has been given. To modify a caption of images already in memory use
761"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
762
Cristy594d2772015-11-15 10:47:42 -0500763<p>The caption can contain special format characters listed in the <a
764href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400765Print Image Properties</a>. These attributes are expanded when the caption
766is finally assigned to the individual images. </p>
767
768<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
769remaining characters in the string. Comments read in from a file are literal;
770no embedded formatting characters are recognized.</p>
771
772<p>Caption meta-data is not visible on the image itself. To do that use the
773<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
774instead.</p>
775
776<p>For example,</p>
777
778<pre>
779-caption "%m:%f %wx%h" bird.miff
780</pre>
781
782<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
783that the image <code>bird.miff</code> has a width of 512 and a height of
784480.</p>
785
786
787<div style="margin: auto;">
788 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
789</div>
790
791<p class="magick-description">color correct with a color decision list.</p>
792
793<p>Here is an example color correction collection:</p>
794
795<pre>
796&lt;?xml version="1.0" encoding="UTF-8"?&gt;
797&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
798 &lt;ColorCorrection id="cc06668"&gt;
799 &lt;SOPNode&gt;
800 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
801 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
802 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
803 &lt;/SOPNode&gt;
804 &lt;SATNode&gt;
805 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
806 &lt;/SATNode&gt;
807 &lt;/ColorCorrection&gt;
808&lt;/ColorCorrectionCollection&gt;
809</pre>
810
811<div style="margin: auto;">
812 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
813</div>
814
815<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
816
817<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
818<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
819<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
820<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
821<code>CMYKA</code>.</p>
822
823<p>The channels above can also be specified as a comma-separated list or can be
824abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
825'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
826'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
827
828For example, to only select the <code>Red</code> and <code>Blue</code> channels
829you can either use </p>
830<pre>
831-channel Red,Blue
832</pre>
833<p>or you can use the short hand form</p>
834<pre>
835-channel RB
836</pre>
837
838<p>All the channels that are present in an image can be specified using the
839special channel type <code>All</code>. Not all operators are 'channel capable',
840but generally any operators that are generally 'grey-scale' image operators,
841will understand this setting. See individual operator documentation. </p>
842
Cristy594d2772015-11-15 10:47:42 -0500843<br/>
Cristy882d9f42015-10-29 16:48:39 -0400844
845<p>On top of the normal channel selection an extra flag can be specified,
846'<code>Sync</code>'. This is turned on by default and if set means that
847operators that understand this flag should perform: cross-channel
848synchronization of the channels. If not specified, then most grey-scale
849operators will apply their image processing operations to each individual
850channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
851setting) completely independently from each other. </p>
852
853<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
854<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
855together in exactly the same way so that colors will remain in-sync. Without
856it being set, then each channel is modified separately and
857independently, which may produce color distortion. </p>
858
859<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
860and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
861the '<code>Sync</code>' flag to modify the behavior of pixel colors according
862to the alpha channel (if present). That is to say it will modify the image
863processing with the understanding that fully-transparent colors should not
864contribute to the final result. </p>
865
866<p>Basically, by default, operators work with color channels in synchronous, and
867treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
868setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
869How each operator does this depends on that operators current implementation.
870Not all operators understands this flag at this time, but that is changing.
871</p>
872
873<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
874channel</a>.</p>
875
876<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
877'<code>RGBK,sync</code>', which specifies that operators act on all color
878channels except the transparency channel, and that all the color channels are
879to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500880(depending on the operation being applied). The 'plus' form <a
881href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400882
Cristy594d2772015-11-15 10:47:42 -0500883<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400884include the following.
885
886<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
887<a href="command-line-options.html#auto-level">-auto-level</a>,
888<a href="command-line-options.html#black-threshold">-black-threshold</a>,
889<a href="command-line-options.html#blur">-blur</a>,
890<a href="command-line-options.html#clamp">-clamp</a>,
891<a href="command-line-options.html#clut">-clut</a>,
892<a href="command-line-options.html#combine">-combine</a>,
893<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
894<a href="command-line-options.html#convolve">-convolve</a>,
895<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
896<a href="command-line-options.html#evaluate">-evaluate</a>,
897<a href="command-line-options.html#function">-function</a>,
898<a href="command-line-options.html#fx">-fx</a>,
899<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
900<a href="command-line-options.html#hald-clut">-hald-clut</a>,
901<a href="command-line-options.html#motion-blur">-motion-blur</a>,
902<a href="command-line-options.html#morphology">-morphology</a>,
903<a href="command-line-options.html#negate">-negate</a>,
904<a href="command-line-options.html#normalize">-normalize</a>,
905<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
906<a href="command-line-options.html#radial-blur">-radial-blur</a>,
907<a href="command-line-options.html#random-threshold">-random-threshold</a>,
908<a href="command-line-options.html#separate">-separate</a>,
909<a href="command-line-options.html#threshold">-threshold</a>, and
910<a href="command-line-options.html#white-threshold">-white-threshold</a>.
911</p>
912
Cristy594d2772015-11-15 10:47:42 -0500913<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
914>+channel</a> default setting is in effect, verses ANY user defined <a
915href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400916default). These operators have yet to be made to understand the newer 'Sync'
917flag. </p>
918
919<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default gray-scale
Cristy594d2772015-11-15 10:47:42 -0500920the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400921has been defined. This is not 'Sync flag controlled, yet. </p>
922
Cristy594d2772015-11-15 10:47:42 -0500923<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
924href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
925color channels if the '<code>alpha</code>' channel is also enabled by <a
926href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400927fully-transparent colors are treated as being fully-transparent, and thus any
928underlying 'hidden' color has no effect on the final results. Typically
929resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
930convolution equivalents however does have a understanding of the 'Sync' flag
931and will thus handle transparency correctly by default. </p>
932
933<p>As a alpha channel is optional within images, some operators will read the
934color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500935alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
936the operator to apply the operation using alpha channels. The <a
937href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400938
939
940
941<div style="margin: auto;">
942 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
943</div>
944
945<p class="magick-description">Simulate a charcoal drawing.</p>
946
947<div style="margin: auto;">
948 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
949</div>
950
951<p class="magick-description">Remove pixels from the interior of an image.</p>
952
953<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>
954and <var>height</var> given in the of the <var>size</var>
955portion of the <var>geometry</var> argument give the number of
956columns and rows to remove. The <var>offset</var> portion of
957the <var>geometry</var> argument is influenced by
958a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
959
960<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
961and moves the remaining corner blocks leftward and upward to close the gaps.</p>
962
963<p>While it can remove internal rows and columns of pixels, it is more
964typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -0500965offsets so as to remove a single edge from an image. Compare this to <a
966href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -0400967sides of the image. </p>
968
Cristy594d2772015-11-15 10:47:42 -0500969<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
970href="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 -0400971
972<div style="margin: auto;">
973 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
974</div>
975
976<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>
977
978<div style="margin: auto;">
979 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
980</div>
981
982<p class="magick-description">Apply the clipping path if one is present.</p>
983
984<p>If a clipping path is present, it is applied to subsequent operations.</p>
985
986<p>For example, in the command</p>
987
988<pre>
989convert cockatoo.tif -clip -negate negated.tif
990</pre>
991
992<p>only the pixels within the clipping path are negated.</p>
993
994<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
995delegate library is not present, the option is ignored.</p>
996
997<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
998
999<div style="margin: auto;">
1000 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1001</div>
1002
1003<p class="magick-description">Clip the image as defined by this mask.</p>
1004
1005<p>Use the alpha channel of the current image as a mask. Any areas that is
1006white is not modified by any of the 'image processing operators' that follow,
1007until the mask is removed. Pixels in the black areas of the clip mask are
1008modified per the requirements of the operator. </p>
1009
1010<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001011a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1012mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001013operation. </p>
1014
1015<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1016
1017<div style="margin: auto;">
1018 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1019</div>
1020
1021<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1022
1023<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>
1024
1025<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1026
1027<div style="margin: auto;">
1028 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1029</div>
1030
1031<p class="magick-description">make a clone of an image (or images).</p>
1032
1033<p>Inside parenthesis (where the operator is normally used) it will make a
1034clone of the images from the last 'pushed' image sequence, and adds them to
1035the end of the current image sequence. Outside parenthesis
1036(not recommended) it clones the images from the current image sequence. </p>
1037
1038<p>Specify the image by its index in the sequence. The first image is index
10390. Negative indexes are relative to the end of the sequence; for
1040example, <code>−1</code>
1041represents the last image of the sequence. Specify a range of images with a
1042dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1043spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1044effectively clone all the images. </p>
1045
1046<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1047in the image sequence, and is thus equivalent to using a argument of
1048'<code>−1</code>'. </p>
1049
1050<div style="margin: auto;">
1051 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1052</div>
1053
1054<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>
1055
1056<p>The second (LUT) image is ordinarily a gradient image containing the
1057histogram mapping of how each channel should be modified. Typically it is a
1058either a single row or column image of replacement color values. If larger
1059than a single row or column, values are taken from a diagonal line from
1060top-left to bottom-right corners.</p>
1061
Cristy594d2772015-11-15 10:47:42 -05001062<p>The lookup is further controlled by the <a
1063href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001064LUT which is not the full length needed by the ImageMagick installed Quality
1065(Q) level. Good settings for this are the '<code>bilinear</code>' and
1066'<code>bicubic</code>' interpolation settings, which give smooth color
1067gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1068lookup of color values. </p>
1069
1070<p>This operator is especially suited to replacing a grayscale image with a
1071specific color gradient from the CLUT image. </p>
1072
1073<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001074setting will have their values replaced. In particular, since the default <a
1075href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1076transparency (alpha/matte channel) is not affected, unless the <a
1077href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1078set, 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 -04001079as the other channels, implying that alpha/matte values are replaced using the
1080alpha/matte values of the original image. </p>
1081
1082<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001083transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1084href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy882d9f42015-10-29 16:48:39 -04001085assumed that image represents a gray-scale gradient which is used for the
1086replacement alpha values. That is you can use a gray-scale CLUT image to
1087adjust a existing images alpha channel, or you can color a gray-scale image
1088using colors form CLUT containing the desired colors, including transparency.
1089</p>
1090
Cristy594d2772015-11-15 10:47:42 -05001091<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001092according to the lookup of the full color RGB value from a 2D representation
1093of a 3D color cube. </p>
1094
1095
1096<div style="margin: auto;">
1097 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1098</div>
1099
1100<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1101
1102<p>Overlay each image in an image sequence according to
1103its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1104an animation at each point in the animation sequence. All images should be
1105the same size, and are assigned appropriate GIF disposal settings for the
1106animation to continue working as expected as a GIF animation. Such frames
1107are more easily viewed and processed than the highly optimized GIF overlay
1108images. </p>
1109
1110<p>The animation can be re-optimized after processing using
1111the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1112there is no guarantee that the restored GIF animation optimization is
1113better than the original. </p>
1114
1115
1116<div style="margin: auto;">
1117 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1118</div>
1119
Cristy594d2772015-11-15 10:47:42 -05001120<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 -04001121
1122<p>Specify the amount of colorization as a percentage. Separate colorization
1123values can be applied to the red, green, and blue channels of the image with
1124a comma-delimited list of colorization
1125values (e.g., <code>-colorize 0,0,50</code>).</p>
1126
1127<div style="margin: auto;">
1128 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1129</div>
1130
1131<p class="magick-description">Define the colormap type.</p>
1132
1133<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1134
1135<p>This option only applies when the default X server visual
1136is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1137to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1138a shared colormap is allocated. The image shares colors with
1139other X clients. Some image colors could be approximated,
1140therefore your image may look very different than intended.
1141If <code>private</code> is chosen, the image colors appear exactly
1142as they are defined. However, other clients may go <var>technicolor</var>
1143when the image colormap is installed.</p>
1144
1145<div style="margin: auto;">
1146 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1147</div>
1148
1149<p class="magick-description">Set the preferred number of colors in the image.</p>
1150
1151<p>The actual number of colors in the image may be less than your request,
1152but never more. Note that this a color reduction option. Images with fewer
1153unique colors than specified by <var>value</var> will have any
1154duplicate or unused colors removed. The ordering of an existing color
1155palette may be altered. When converting an image from color to grayscale,
1156it is more efficient to convert the image to the gray colorspace before
1157reducing the number of colors. Refer to
1158the <a href="quantize.html">
1159color reduction algorithm</a> for more details.</p>
1160
1161<div style="margin: auto;">
1162 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1163</div>
1164
1165<p class="magick-description">apply color correction to the image.</p>
1166
1167<p>This option permits saturation changes, hue rotation, luminance to alpha,
1168and various other effects. Although variable-sized transformation matrices
1169can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1170for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1171Adobe Flash except offsets are in column 6 rather than 5 (in support of
1172CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1173
1174<p>As an example, to add contrast to an image with offsets, try this command:</p>
1175
1176<pre>
1177convert kittens.jpg -color-matrix \
1178 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1179 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1180 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1181 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1182 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1183 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1184</pre>
1185<div style="margin: auto;">
1186 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1187</div>
1188
1189<p class="magick-description">Set the image colorspace.</p>
1190
1191<p>Choices are:</p>
1192
1193<pre>
1194CMY CMYK Gray HCL
1195HCLp HSB HSI HSL
1196HSV HWB Lab LCHab
1197LCHuv LMS Log Luv
1198OHTA Rec601YCbCr Rec709YCbCr RGB
1199scRGB sRGB Transparent xyY
1200XYZ YCbCr YCC YDbDr
1201YIQ YPbPr YUV
1202</pre>
1203
1204<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1205
1206<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>
1207
1208<table class="table table-condensed table-striped">
1209 <caption>Conversion of RGB to Other Color Spaces</caption>
1210 <tr><th valign="middle">CMY</th></tr>
1211 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1212 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1213 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1214 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1215 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1216 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1217 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1218 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1219
1220 <tr><th valign="middle">Gray</th></tr>
1221 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1222
1223 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1224 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1225 <tr><td valign="middle">S=distance from axis outward</td></tr>
1226 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1227
1228 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1229 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1230 <tr><td valign="middle">S=distance from axis outward</td></tr>
1231 <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>
1232
1233 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1234 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1235 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1236 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1237
1238 <tr><th valign="middle">LAB</th></tr>
1239 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1240 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1241 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1242
1243 <tr><th valign="middle">LOG</th></tr>
1244 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1245 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1246 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1247
1248 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1249 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1250 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1251 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1252
1253 <tr><th valign="middle">Rec601Luma</th></tr>
1254 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1255
1256 <tr><th valign="middle">Rec601YCbCr</th></tr>
1257 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1258 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1259 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1260
1261 <tr><th valign="middle">Rec709Luma</th></tr>
1262 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1263
1264 <tr><th valign="middle">Rec709YCbCr</th></tr>
1265 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1266 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1267 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1268
1269 <tr><th valign="middle">sRGB</th></tr>
1270 <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>
1271 <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>
1272 <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>
1273
1274 <tr><th valign="middle">XYZ</th></tr>
1275 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1276 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1277 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1278
1279 <tr><th valign="middle">YCC</th></tr>
1280 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1281 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1282 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1283
1284 <tr><th valign="middle">YCbCr</th></tr>
1285 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1286 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1287 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1288
1289 <tr><th valign="middle">YIQ</th></tr>
1290 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1291 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1292 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1293
1294 <tr><th valign="middle">YPbPr</th></tr>
1295 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1296 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1297 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1298
1299 <tr><th valign="middle">YUV</th></tr>
1300 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1301 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1302 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1303</table>
1304
1305<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1306
1307<div style="margin: auto;">
1308 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1309</div>
1310
1311<p class="magick-description">Combine one or more images into a single image.</p>
1312
1313<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1314combined image are taken from the grayscale values of each image in the
1315sequence, in order. For the default -channel setting of <code>RGB</code>, this
1316means the first image is assigned to the <code>Red</code> channel, the second
1317to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1318
Cristy594d2772015-11-15 10:47:42 -05001319<p>This option can be thought of as the inverse to <a
1320href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001321Thus, in the following example, the final image should be a copy of the
1322original. </p>
1323
1324<pre>
1325convert original.png -channel RGB -separate sepimage.png
1326convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1327 -combine imagecopy.png
1328</pre>
1329
1330<div style="margin: auto;">
1331 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1332</div>
1333
1334<p class="magick-description">Embed a comment in an image.</p>
1335
1336<p>This option sets the comment meta-data of an image read in after this
1337option has been given. To modify a comment of images already in memory use
1338"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1339
Cristy594d2772015-11-15 10:47:42 -05001340<p>The comment can contain special format characters listed in the <a
1341href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001342Print Image Properties</a>. These attributes are expanded when the comment
1343is finally assigned to the individual images. </p>
1344
1345<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1346remaining characters in the string. Comments read in from a file are literal;
1347no embedded formatting characters are recognized.</p>
1348
1349<p>Comment meta-data are not visible on the image itself. To do that use the
1350<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1351instead.</p>
1352
1353<p>For example,</p>
1354
1355<pre>
1356-comment "%m:%f %wx%h" bird.miff
1357</pre>
1358
1359<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1360that the image <code>bird.miff</code> has a width of 512 and a height of
1361480.</p>
1362
1363<div style="margin: auto;">
1364 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1365</div>
1366
1367<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1368
1369<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>
1370
1371<pre>
Cristy594d2772015-11-15 10:47:42 -05001372convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001373</pre>
1374
1375<p>To get the metric value use the string format "%[distortion]".</p>
1376
1377<pre>
1378convert image.png reference.png -metric RMSE -compare -format \
1379 "%[distortion]" info:
1380</pre>
1381
1382<div style="margin: auto;">
1383 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1384</div>
1385
1386<p class="magick-description">perform complex mathematics on an image sequence</p>
1387
1388Choose from these operators:
1389
1390<pre>
1391add
1392conjugate
1393divide
1394magnitude-phase
1395multiply
1396real-imaginary
1397subtract
1398</pre>
1399
1400<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>
1401
1402<div style="margin: auto;">
1403 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1404</div>
1405
1406<p class="magick-description">Set the type of image composition.</p>
1407
1408<p>See <a href="compose.html">Alpha Compositing</a> for
1409a detailed discussion of alpha compositing.</p>
1410
1411<p>This setting effects image processing operators that merge two (or more)
1412images together in some way. This includes the operators,
1413<a href="command-line-options.html#composite">-compare</a>,
1414<a href="command-line-options.html#composite">-composite</a>,
1415<a href="command-line-options.html#layers">-layers</a> composite,
1416<a href="command-line-options.html#flatten">-flatten</a>,
1417<a href="command-line-options.html#mosaic">-mosaic</a>,
1418<a href="command-line-options.html#layers">-layers</a> merge,
1419<a href="command-line-options.html#border">-border</a>,
1420<a href="command-line-options.html#frame">-frame</a>,
1421and <a href="command-line-options.html#extent">-extent</a>. </p>
1422
1423<p>It is also one of the primary options for the "<code>composite</code>"
1424command. </p>
1425
1426
1427<div style="margin: auto;">
1428 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1429</div>
1430
1431<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1432
1433<p>Take the first image 'destination' and overlay the second 'source' image
1434according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001435of the 'source' or 'overlay' image is controlled according to <a
1436href="command-line-options.html#geometry" >-geometry</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001437settings. </p>
1438
1439<p>If a third image is given this is treated as a gray-scale blending 'mask' image
1440relative to the first 'destination' image. This mask is blended with the
1441source image. However for the '<code>displace</code>' compose method, the
1442mask is used to provide a separate Y-displacement image instead. </p>
1443
1444<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001445arguments or flags these can be provided by setting the <a
1446href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001447appropriately for the compose method. </p>
1448
1449<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001450image outside the overlay area. You can disable this by setting the special <a
1451href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001452to '<code>false</code>'. </p>
1453
1454<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>
1455
1456
1457<div style="margin: auto;">
1458 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1459</div>
1460
1461<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1462
Cristy594d2772015-11-15 10:47:42 -05001463<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1464>Fax</code>, <code>Group4</code>, <code
1465>JPEG</code>, <code>JPEG2000</code>, <code
1466>Lossless</code>, <code>LZW</code>, <code
1467>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001468
1469<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1470compress</a>.</p>
1471
1472<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1473uncompressed format. The default is the compression type of the specified
1474image file.</p>
1475
1476<p>If <code>LZW</code> compression is specified but LZW compression has not been
1477enabled, the image data is written in an uncompressed LZW format that can be
1478read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1479
1480<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1481JPEG library has been patched to support it. Use of lossless JPEG is generally
1482not recommended.</p>
1483
1484<p>
1485When writing an ICO file, you may request that the images be encoded in
1486PNG format, by specifying <code>Zip</code> compression.</p>
1487
1488<p>
1489When writing a JNG file, specify <code>Zip</code> compression to request that
1490the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1491to request that it be encoded in JPG "JDAA" format.</p>
1492
1493<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1494to be used by JPEG, PNG, MIFF, and MPEG encoders.
1495Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1496sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1497the chroma channels.</p>
1498
1499<div style="margin: auto;">
1500 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1501</div>
1502
1503<p class="magick-description">connected-components uniquely labeled, choose from 4 or 8 way connectivity.</p>
1504
Cristy594d2772015-11-15 10:47:42 -05001505<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 -04001506
1507<div style="margin: auto;">
1508 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1509</div>
1510
1511<p class="magick-description">Enhance or reduce the image contrast.</p>
1512
1513<p>This option enhances the intensity differences between the lighter and
1514darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1515the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1516contrast.</p>
1517
1518<p>For a more pronounced effect you can repeat the option:</p>
1519
1520<pre>
1521convert rose: -contrast -contrast rose_c2.png
1522</pre>
1523
1524<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05001525 <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 -04001526</div>
1527
1528<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1529
1530<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 -05001531<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001532
Cristy594d2772015-11-15 10:47:42 -05001533<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1534>-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 -04001535minus 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>
1536
1537<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1538the 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 -05001539clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1540>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001541prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1542
1543<p>Internally operator works by creating a histogram bin, and then uses that
1544bin to modify the image. As such some colors may be merged together when they
1545originally fell into the same 'bin'. </p>
1546
1547<p>All the channels are normalized in concert by the came amount so as to
Cristy594d2772015-11-15 10:47:42 -05001548preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1549setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001550setting will normalize the RGB channels independently.</p>
1551
Cristy594d2772015-11-15 10:47:42 -05001552<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001553normalization of mathematical images. </p>
1554
1555<p>This operator is under review for re-development. </p>
1556
1557
1558<div style="margin: auto;">
1559 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1560</div>
1561
1562<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1563
1564<p>The <var>kernel</var> is a matrix specified as
1565a comma-separated list of integers (with no spaces), ordered left-to right,
1566starting with the top row. Presently, only odd-dimensioned kernels are
1567supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15687<sup>2</sup>=49, etc. </p>
1569
Cristy594d2772015-11-15 10:47:42 -05001570<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 -04001571positive and negative results are relative to a user-specified bias value.
1572This is important for non-HDRI compilations of ImageMagick when dealing with
1573convolutions that contain negative as well as positive values. This is
1574especially the case with convolutions involving high pass filters or edge
1575detection. Without an output bias, the negative values is clipped at zero.
1576</p>
1577
Cristy594d2772015-11-15 10:47:42 -05001578<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 -04001579negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001580See the discussion on HDRI implementations of ImageMagick on the page <a
1581href="high-dynamic-range.html">High
1582Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1583href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001584<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1585entry. </p>
1586
1587
1588<div style="margin: auto;">
1589 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1590</div>
1591
1592<p class="magick-description">copy pixels from one area of an image to another.</p>
1593
1594<div style="margin: auto;">
1595 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1596</div>
1597
1598<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1599
1600<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1601
1602<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1603after cropping, and <var>x</var> and <var>y</var> in the
1604<var>offset</var> (if present) gives the location of the top left
1605corner of the cropped image with respect to the original image. To specify the
1606amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1607
1608<p>If the <var>x</var> and <var>y</var> offsets are
1609present, a single image is generated, consisting of the pixels from the
1610cropping region. The offsets specify the location of the upper left corner of
1611the cropping region measured downward and rightward with respect to the upper
1612left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1613present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1614gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001615the right edge of the cropping region. Similarly, if the <a
1616href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001617<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1618upward between the bottom edges.</p>
1619
1620<p>If the <var>x</var> and <var>y</var> offsets are
1621omitted, a set of tiles of the specified geometry, covering the entire input
1622image, is generated. The rightmost tiles and the bottom tiles are smaller if
1623the specified geometry extends beyond the dimensions of the input image.</p>
1624
1625<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1626
1627<p>By adding a exclamation character flag to the geometry argument, the
1628cropped images virtual canvas page size and offset is set as if the
1629geometry argument was a viewport or window. This means the canvas page size
1630is set to exactly the same size you specified, the image offset set
1631relative top left corner of the region cropped. </p>
1632
1633<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1634special single pixel transparent 'missed' image is returned, and a 'crop
1635missed' warning given. </p>
1636
Cristy594d2772015-11-15 10:47:42 -05001637<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 -04001638cropping the image to ensure the crop coordinate frame is relocated to the
1639upper-left corner of the visible image.
1640
Cristy594d2772015-11-15 10:47:42 -05001641Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001642remove the page offset that will be left behind. This is especially true when
1643you are going to write to an image format such as PNG that supports an image
1644offset.</p>
1645
1646<div style="margin: auto;">
1647 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1648</div>
1649
1650<p class="magick-description">displace image colormap by amount.</p>
1651
1652<p><var>Amount</var> defines the number of positions each
1653colormap entry is shifted.</p>
1654
1655
1656<div style="margin: auto;">
1657 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1658</div>
1659
1660<p class="magick-description">enable debug printout.</p>
1661
1662<p>The <code>events</code> parameter specifies which events are to be logged. It
1663can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1664a comma-separated list consisting of one or more of the following domains:
1665<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1666<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1667<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1668<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1669<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1670
1671
1672<p>For example, to log cache and blob events, use.</p>
1673
1674<pre>
1675convert -debug "Cache,Blob" rose: rose.png
1676</pre>
1677
1678<p>The <code>User</code> domain is normally empty, but developers can log user
1679events in their private copy of ImageMagick.</p>
1680
1681<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1682debug</a>.</p>
1683
1684<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1685output.</p>
1686
1687<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1688
Cristy594d2772015-11-15 10:47:42 -05001689<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1690>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001691environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1692option.</p>
1693
1694
1695<div style="margin: auto;">
1696 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1697</div>
1698
1699<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1700
1701<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1702
Cristy594d2772015-11-15 10:47:42 -05001703<p>For more information, see the webpage, <a
1704href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001705Decipher an Image</a>.</p>
1706
1707
1708<div style="margin: auto;">
1709 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1710</div>
1711
1712<p class="magick-description">find areas that has changed between images </p>
1713
Cristy594d2772015-11-15 10:47:42 -05001714<p>Given a sequence of images all the same size, such as produced by <a
1715href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001716a smaller image of just the area that changed relative to the previous image.
1717</p>
1718
1719<p>The resulting sequence of images can be used to optimize an animation
1720sequence, though will not work correctly for GIF animations when parts of the
1721animation can go from opaque to transparent. </p>
1722
1723<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1724method '<code>compare-any</code>'. </p>
1725
1726
1727<div style="margin: auto;">
1728 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1729</div>
1730
1731<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1732
1733<p>This option creates one or more definitions for coders and decoders to use
1734while reading and writing image data. Definitions are generally used to
1735control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001736beyond what is provided by normal means. Defined settings are listed in <a
1737href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001738as "Artifacts". </p>
1739
1740<p>If <var>value</var> is missing for a definition, an empty-valued
1741definition of a flag is created with that name. This used to control on/off
1742options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1743previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1744existing definitions.</p>
1745
Cristy594d2772015-11-15 10:47:42 -05001746<p>The same 'artifact' settings can also be defined using the <a
1747href="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 -04001748Properties</a> in the defined value. </p>
1749
1750<p>The <var>option</var> and <var>key</var> are case-independent (they are
1751converted to lowercase for use within the decoders) while the <var>value</var>
1752is case-dependent.</p>
1753
1754<p>Such settings are global in scope, and affect all images and operations. </p>
1755
1756<p>The following definitions are just some of the artifacts that are
1757available:</p>
1758
1759<table class="table table-condensed table-striped">
1760 <tr>
1761 <td>bmp:format=<var>value</var></td>
1762 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1763 and <var>bmp4</var>. This option can be useful when the
1764 method of prepending "BMP2:" to the output filename is inconvenient or
1765 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1766 </tr>
1767
1768 <tr>
1769 <td>colorspace:auto-grayscale=<var>on|off</var></td>
1770 <td>prevent automatic conversion to grayscale inside coders that support
1771 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1772 not need this define. With PNG, just use PNG24:image. With TIF, just use
1773 -type truecolor. JPG and PSD will need this define.</td>
1774 </tr>
1775
1776 <tr>
1777 <td>complex:snr=<var>value</var></td>
1778 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1779 </tr>
1780
1781 <tr>
1782 <td>compose:args=<var>arguments</var></td>
1783 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy594d2772015-11-15 10:47:42 -05001784 -composite. See <a href="http://www.imagemagick.org/www/compose.html"
1785 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001786 </tr>
1787
1788 <tr>
1789 <td>compose:clamp=<var>on|off</var></td>
1790 <td>set each pixel whose value is below zero to zero and any the pixel whose value is above the quantum range to the quantum range (e.g. 65535) otherwise the pixel value remains unchanged. Define supported in ImageMagick 6.9.1-3 and above.</td>
1791 </tr>
1792
1793 <tr>
1794 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1795 <td>Defines the kernel scaling. The special flag ! automatically scales to
1796 full dynamic range. The ! flag can be used in combination with a factor or
1797 percent. The factor or percent is then applied after the automatic scaling.
1798 An example is 50%!. This produces a result 50% darker than full dynamic
1799 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1800 example when some values are positive and some are negative as in edge
1801 detection kernels. The origin addition adds that value to the center
1802 pixel of the kernel. This produces and effect that is like adding the image
1803 that many times to the result of the filtered image. The typical value
1804 is 1 so that the original image is added to the result of the convolution.
1805 The default is 0.</td>
1806 </tr>
1807
1808 <tr>
1809 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001810 <td>Outputs (to 'standard error') all the information about a specified <a
1811 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001812 </tr>
1813
1814 <tr>
1815 <td>dcm:display-range=<var>reset</var></td>
1816 <td>Sets the display range to the minimum and maximum pixel values for the
1817 DCM image format.</td>
1818 </tr>
1819
1820 <tr>
1821 <td>dds:cluster-fit=<var>true|false</var></td>
1822 <td>Enables the dds cluster-fit.</td>
1823 </tr>
1824
1825 <tr>
1826 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1827 <td>Sets the dds compression.</td>
1828 </tr>
1829
1830 <tr>
1831 <td>dds:mipmaps=<var>value</var></td>
1832 <td>Sets the dds number of mipmaps.</td>
1833 </tr>
1834
1835 <tr>
1836 <td>dds:weight-by-alpha=<var>true|false</var></td>
1837 <td>Enables the dds alpha weighting.</td>
1838 </tr>
1839
1840 <tr>
1841 <td>delegate:bimodal=<var>true</var></td>
1842 <td>Specifies direct conversion from Postscript to PDF.</td>
1843 </tr>
1844
1845 <tr>
1846 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001847 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1848 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001849 </tr>
1850
1851 <tr>
1852 <td>distort:viewport=<var>WxH+X+Y</var></td>
1853 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1854 </tr>
1855
1856 <tr>
1857 <td>dot:layout-engine=<var>value</var></td>
1858 <td>Specifies the layout engine for the DOT image format (e.g.
1859 <code>neato</code>).</td>
1860 </tr>
1861
1862 <tr>
1863 <td>filter:option=<var>value</var></td>
1864 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1865 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1866 </tr>
1867
1868 <tr>
1869 <td>fourier:normalize=<var>inverse</var></td>
1870 <td>Sets the location for the FFT/IFT normalization as use by
1871 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1872 <var>forward</var>.</td>
1873 </tr>
1874
1875 <tr>
1876 <td>h:format=<var>value</var></td>
1877 <td>Set the image encoding format use when writing a C-style header.
1878 <var>format</var> can be any output format supported by ImageMagick
1879 except for <var>h</var> and <var>magick</var></td>. If this
1880 option is omitted, the default is <var>GIF</var> for PseudoClass
1881 images and <var>PNM</var> for DirectClass images.
1882 </tr>
1883
1884 <tr>
1885 <td>icon:auto-resize</td>
1886 <td>Automatically stores multiple sizes when writing an ico image
1887 (requires a 256x256 input image).</td>
1888 </tr>
1889
1890 <tr>
1891 <td>jp2:layer-number=<var>value</var></td>
1892 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1893 and J2K</td>
1894 </tr>
1895
1896 <tr>
1897 <td>jp2:number-resolutions=<var>value</var></td>
1898 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and J2K</td>
1899 </tr>
1900
1901 <tr>
1902 <td>jp2:progression-order=<var>value</var></td>
1903 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1904 J2K</td>
1905 </tr>
1906
1907 <tr>
1908 <td>jp2:quality=<var>value,value...</var></td>
1909 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1910 right in ascending order. The default is a single lossless quality layer.
1911 Same for JPT, JC2, and J2K</td>
1912 </tr>
1913
1914 <tr>
1915 <td>jp2:rate=<var>value</var></td>
1916 <td>Specify the compression factor to use while writing JPEG-2000 files. The
1917 compression factor is the reciprocal of the compression ratio. The valid
1918 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1919 this value overrides the -quality setting. A quality setting of 75
1920 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
1921 </tr>
1922
1923 <tr>
1924 <td>jp2:reduce-factor=<var>value</var></td>
1925 <td>Sets the number of highest resolution levels to be discarded.Same for
1926 JPT, JC2, and J2K</td>
1927 </tr>
1928
1929 <tr>
1930 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05001931 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001932 </tr>
1933
1934 <tr>
1935 <td>jpeg:colors=<var>value</var></td>
1936 <td>Set the desired number of colors and let the JPEG encoder do the
1937 quantizing.</td>
1938 </tr>
1939
1940 <tr>
1941 <td>jpeg:dct-method=<var>value</var></td>
1942 <td>Choose from <code>default</code>, <code>fastest</code>,
1943 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
1944 </tr>
1945
1946 <tr>
1947 <td>jpeg:extent=<var>value</var></td>
1948 <td>Restrict the maximum JPEG file size, for example <code>-define
1949 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
1950 compression quality level that results in an output file that does not
1951 exceed the value. The <code>-quality</code> option is ignored if it
1952 is also present.</td>
1953 </tr>
1954
1955 <tr>
1956 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05001957 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001958 </tr>
1959
1960 <tr>
1961 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05001962 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001963 </tr>
1964
1965 <tr>
1966 <td>jpeg:q-table=<var>table</var></td>
Cristy594d2772015-11-15 10:47:42 -05001967 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001968 </tr>
1969
1970 <tr>
1971 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
Cristy594d2772015-11-15 10:47:42 -05001972 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001973 </tr>
1974
1975 <tr>
1976 <td>jpeg:size=<var>geometry</var></td>
1977 <td>Set the size hint of a JPEG image, for
1978 example, <code>-define jpeg:size=128x128</code>.
1979 It is most useful for increasing performance and reducing the memory
1980 requirements when reducing the size of a large JPEG image.</td>
1981 </tr>
1982
1983 <tr>
1984 <td>json:features</td>
1985 <td>includes features in verbose information</td>
1986 </tr>
1987
1988 <tr>
1989 <td>json:limit</td>
Cristy594d2772015-11-15 10:47:42 -05001990 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001991 </tr>
1992
1993 <tr>
1994 <td>json:locate</td>
Cristy594d2772015-11-15 10:47:42 -05001995 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001996 </tr>
1997
1998 <tr>
1999 <td>json:moments</td>
2000 <td>includes image moments in verbose information</td>
2001 </tr>
2002
2003 <tr>
2004 <td>magick:format=<var>value</var></td>
2005 <td>Set the image encoding format use when writing a C-style header.
2006 This is the same as "h:format=format" described above.</td>.
2007 </tr>
2008
2009 <tr>
2010 <td>mng:need-cacheoff</td>
2011 <td>turn playback caching off for streaming MNG.</td>
2012 </tr>
2013
2014 <tr>
2015 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002016 <td>Specifies how to merge results generated by multiple<a
2017 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002018 typical value is 'lighten' as used, for example, with the sobel edge
2019 kernels. </td>
2020 </tr>
2021
2022 <tr>
2023 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002024 <td>Outputs (to 'standard error') all the information about a generated <a
2025 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002026 </tr>
2027
2028 <tr>
2029 <td>pcl:fit-to-page=<var>true</var></td>
2030
Cristy594d2772015-11-15 10:47:42 -05002031 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002032 <td>pdf:fit-page=<var>geometry</var></td>
2033 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2034 being read. The geometry is either WxH{%} or page size. No offsets are
2035 allowed. (introduced in IM 6.8.8-8)</td>
2036 </tr>
2037
2038 <tr>
2039 <td>pdf:fit-to-page=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002040 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002041 </tr>
2042
2043 <tr>
2044 <td>pdf:use-cropbox=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002045 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002046 </tr>
2047
2048 <tr>
2049 <td>pdf:use-trimbox=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002050 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002051 </tr>
2052
2053 <tr>
2054 <td>png:bit-depth=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05002055 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002056 </tr>
2057 <tr>
2058 <td>png:color-type=<var>value</var></td>
2059 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2060 encoder to use a different bit-depth and color-type than it would have
2061 normally selected, but only if this does not cause any loss of image
2062 quality. Any attempt to reduce image quality is treated as an error and no
2063 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2064 can use these "defines" to cause it to be written as an 8-bit grayscale,
2065 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2066 you cannot force it to be written as a grayscale or indexed PNG. If you
2067 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2068 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2069 reduce the image quality prior to using the PNG encoder. Note that in
2070 indexed PNG files, "bit-depth" refers to the number of bits per index,
2071 which can be 1, 2, 4, or 8. In such files, the color samples always have
2072 8-bit depth.</td>
2073 </tr>
2074
2075 <tr>
2076 <td>png:compression-filter=<var>value</var></td>
2077 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2078 5 means adaptive filtering except for images with a colormap, 6 means
2079 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2080 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2081 filtering.</td>
2082 </tr>
2083
2084 <tr>
2085 <td>png:compression-level=<var>value</var></td>
2086 <td> valid values are 0 through 9, with 0 providing the least but fastest
2087 compression and 9 usually providing the best and always the slowest.</td>
2088 </tr>
2089
2090 <tr>
2091 <td>png:compression-strategy=<var>value</var></td>
2092 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2093 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2094 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2095 values 3 and 4, respectively, will use the zlib default strategy
2096 instead.</td>
2097 </tr>
2098
2099 <tr>
2100 <td>png:format=<var>value</var></td>
2101 <td> valid values are <var>png8</var>, <var>png24</var>,
2102 <var>png32</var>, <var>png48</var>,
2103 <var>png64</var>, and <var>png00</var>.
2104 This property can be useful for specifying
2105 the specific PNG format to be used, when the usual method of prepending the
2106 format name to the output filename is inconvenient, such as when writing
2107 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2108 Value = <var>png8</var> reduces the number of colors to 256,
2109 only one of which may be fully transparent, if necessary. The other
2110 values do not force any reduction of quality; it is an error to request
2111 a format that cannot represent the image data without loss (except that
2112 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2113 Value = <var>png24</var> and <var>png48</var>
2114 allow transparency, only if a single color is fully transparent and that
2115 color does not also appear in an opaque pixel; such transparency is
2116 written in a PNG <code>tRNS</code> chunk.
2117 Value = <var>png00</var> causes the image to inherit its
2118 color-type and bit-depth from the input image, if the input was also
2119 a PNG.</td>
2120 </tr>
2121
2122 <tr>
2123 <td>png:exclude-chunk=<var>value</var></td>
2124
Cristy594d2772015-11-15 10:47:42 -05002125 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002126 <td>png:include-chunk=<var>value</var></td>
2127 <td>ancillary chunks to be excluded from or included in PNG output.
2128
2129 <p>The <var>value</var> can be the name of a PNG chunk-type such
2130 as <var>bKGD</var>, a comma-separated list of chunk-names
2131 (which can include the word <var>date</var>, the word
2132 <var>all</var>, or the word <var>none</var>).
2133 Although PNG chunk-names are case-dependent, you can use all lowercase
2134 names if you prefer.</p>
2135
2136 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2137 of the PNG encoder and have no effect on the PNG decoder.</p>
2138
2139 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2140 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2141 only be written if gamma is not 1/2.2, since most decoders assume
2142 sRGB and gamma=1/2.2 when no colorspace information is included in
2143 the PNG file. Because the list is processed from left to right, you
2144 can achieve this with a single define:</p>
2145
2146<pre>
2147-define png:include-chunk=none,gAMA
2148</pre>
2149
2150 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2151 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2152 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2153 entire ICC profile. To force the PNG encoder to write the sRGB
2154 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2155 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2156
2157 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2158 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2159 entries appearing in the list will be ignored.</p>
2160
2161 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2162 image has transparency, the PNG colortype is forced to be 4 or 6
2163 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2164 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2165 on the PNG colortype of the output image.</p>
2166
2167 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2168 following for PNG output:</p>
2169
2170<pre>
2171-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2172</pre>
2173
2174 <p>The default behavior is to include all known PNG ancillary chunks
2175 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2176 and to exclude all PNG chunks that are unknown to ImageMagick,
2177 regardless of their PNG "copy-safe" status as described in the
2178 PNG specification.</p>
2179
2180 <p>Any chunk names that are not known to ImageMagick are ignored
2181 if they appear in either the "include-chunk" or "exclude-chunk" list.
2182 The ancillary chunks currently known to ImageMagick are
2183 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2184 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2185 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2186
2187 <p>You can also put <code>date</code> in the list to include or exclude
2188 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2189 inserts in the output PNG.</p></td>
2190 </tr>
2191
2192 <tr>
2193 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002194 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002195 try to optimize the palette, eliminating unused entries and putting
2196 the transparent colors first. If this flag is set, that behavior
2197 is suppressed.</td>
2198 </tr>
2199
2200 <tr>
2201 <td>png:preserve-iCCP[=<var>true</var>]</td>
2202 <td>By default, the PNG decoder and encoder examine any ICC profile
2203 that is present, either from an <code>iCCP</code> chunk in the PNG
2204 input or supplied via an option, and if the profile is recognized
2205 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2206 You can use <code>-define png:preserve-iCCP</code> to prevent
2207 this from happening; in such cases the <code>iCCP</code> chunk
2208 will be read or written and no <code>sRGB</code> chunk will be
2209 written. There are some ICC profiles that claim to be sRGB but
2210 have various errors that cause them to be rejected by libpng16; such
2211 profiles are recognized anyhow and converted to the <code>sRGB</code>
2212 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2213 is present. Note that not all "sRGB" ICC profiles are recognized
2214 yet; we will add them to the list as we encounter them.</td>
2215 </tr>
2216
2217 <tr>
2218 <td>png:swap-bytes[=<var>true</var>]</td>
2219 <td>The PNG specification requires that any multi-byte integers be stored in
2220 network byte order (MSB-LSB endian). This option allows you to
2221 fix any invalid PNG files that have 16-bit samples stored incorrectly
2222 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2223 must appear before the input filename on the commandline. The swapping
2224 is done during the libpng decoding operation.</td>
2225 </tr>
2226
2227 <tr>
2228 <td>profile:skip=<var>name1,name2,...</var></td>
2229 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2230 skip all named profiles in the image. Many named profiles exist,
2231 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2232 </tr>
2233
2234 <tr>
2235 <td>ps:imagemask</td>
2236 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2237 create Postscript files that render bilevel images with the Postscript
2238 imagemask operator instead of the image operator.</td>
2239 </tr>
2240
2241 <tr>
2242 <td>psd:alpha-unblend=off</td>
2243 <td>Disables new automatic un-blending of transparency with the base image
2244 for the flattened layer 0 before adding the alpha channel to the output
2245 image. This define must be placed before the input psd image. (Available
2246 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2247 prevents the transparency from being applied twice in the output
2248 image.</td>
2249 </tr>
2250
2251 <tr>
2252 <td>quantum:format=<var>type</var></td>
2253 <td>Set the type to <code>floating-point</code> to specify a floating-point
2254 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2255 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2256 included, the result is a single precision floating point format.
2257 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2258 double precision floating point format.</td>
2259 </tr>
2260
2261 <tr>
2262 <td>quantum:polarity=<var>photometric-interpretation</var></td>
2263 <td>Set the photometric-interpretation of an image (typically for TIFF image
2264 file format) to either <code>min-is-black</code> (default) or
2265 <code>min-is-white</code>.</td>
2266 </tr>
2267
2268 <tr>
2269 <td>sample:offset=<var>geometry</var></td>
2270 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002271 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002272 </tr>
2273
2274 <tr>
2275 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002276 <td>Outputs (to 'standard error') all the information about a generated <a
2277 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002278 </tr>
2279
2280 <tr>
2281 <td>stream:buffer-size=<var>value</var></td>
2282 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2283 </tr>
2284
2285 <tr>
2286 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
2287 <td>Specify the alpha extra samples as associated, unassociated or unspecified </td>
2288 </tr>
2289
2290 <tr>
2291 <td>tiff:endian=<var>msb|lsb</var></td>
Cristy594d2772015-11-15 10:47:42 -05002292 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002293 </tr>
2294
2295 <tr>
2296 <td>tiff:exif-properties=<var>false</var></td>
2297 <td>Skips reading the EXIF properties.</td>
2298 </tr>
2299
2300 <tr>
2301 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristy594d2772015-11-15 10:47:42 -05002302 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002303 </tr>
2304
2305 <tr>
2306 <td>tiff:ignore-layers=<var>true</var></td>
2307 <td>Ignores the photoshop layers.</td>
2308 </tr>
2309
2310 <tr>
2311 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2312 <td>Allows one or more tag ID values to be ignored.</td>
2313 </tr>
2314
2315 <tr>
2316 <td>tiff:rows-per-strip=<var>value</var></td>
2317 <td>Sets the number of rows per strip</td>
2318 </tr>
2319
2320 <tr>
2321 <td>tiff:tile-geometry=<var>WxH</var></td>
2322 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2323 PTIF: before the outputname</td>
2324 </tr>
2325</table>
2326
2327<p>For example, to create a postscript file that will render only the black
2328pixels of a bilevel image, use:</p>
2329
2330<pre>
2331convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2332</pre>
2333
2334<p>Set attributes of the image registry by prefixing the value with
2335<code>registry:</code>. For example, to set a temporary path to put work files,
2336use:</p>
2337
2338<pre>
2339-define registry:temporary-path=/data/tmp
2340</pre>
2341
2342<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002343 <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 -04002344</div>
2345
2346<p class="magick-description">display the next image after pausing.</p>
2347
2348<p>This option is useful for regulating the animation of image sequences
2349<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2350next image. The default is no delay between each showing of the image
2351sequence. The default ticks-per-second is 100.</p>
2352
2353<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2354value exceeds the given delay. <code>&lt;</code> changes the image delay
2355<var>only</var> if current value is less than the given delay. For example, if
2356you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2357not change. However, if the image delay is 40 or 50, the delay it is changed
2358to 30. Enclose the given delay in quotation marks to prevent the
2359<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2360a file redirection.</p>
2361
2362
2363<div style="margin: auto;">
2364 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2365</div>
2366
2367<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2368
2369<p>Specify the image by its index in the sequence. The first image is index
23700. Negative indexes are relative to the end of the sequence, for example, -1
2371represents the last image of the sequence. Specify a range of images with
2372a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
2373<code>+delete</code> to delete the last image in the current image sequence.</p>
2374
2375
2376<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002377 <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 -04002378</div>
2379
2380<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2381
2382<p>This option specifies the image resolution to store while encoding a raster
2383image or the canvas resolution while rendering (reading) vector formats such
2384as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2385provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002386raster image. The default unit of measure is in dots per inch (DPI). The <a
2387href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002388instead.</p>
2389
2390<p>The default resolution is 72 dots per inch, which is equivalent to one
2391point per pixel (Macintosh and Postscript standard). Computer screens are
2392normally 72 or 96 dots per inch, while printers typically support 150, 300,
2393600, or 1200 dots per inch. To determine the resolution of your display, use
2394a ruler to measure the width of your screen in inches, and divide by the
2395number of horizontal pixels (1024 on a 1024x768 display).</p>
2396
2397<p>If the file format supports it, this option may be used to update the
2398stored image resolution. Note that Photoshop stores and obtains image
2399resolution from a proprietary embedded profile. If this profile is not
2400stripped from the image, then Photoshop will continue to treat the image using
2401its former resolution, ignoring the image resolution specified in the standard
2402file header.</p>
2403
2404<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2405does not alter the underlying raster image. It may be used to adjust the
2406rendered size for desktop publishing purposes by adjusting the scale applied
2407to the pixels. To resize the image so that it is the same size at a different
2408resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2409
2410<div style="margin: auto;">
2411 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2412</div>
2413
2414<p class="magick-description">depth of the image.</p>
2415
2416<p>This the number of bits in a color sample within a pixel. Use this option
2417to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2418or CMYK, or to change the depth of any image after it has been read.</p>
2419
2420<div style="margin: auto;">
2421 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2422</div>
2423
2424<p class="magick-description">obtain image by descending window hierarchy.</p>
2425
2426<div style="margin: auto;">
2427 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold</var></h3>
2428</div>
2429
2430<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2431
2432<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
2433<var>width</var></code> to auto crop the image. The set argument is the pixel
2434width of the image background (e.g 40).</p>
2435
2436<div style="margin: auto;">
2437 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2438</div>
2439
2440<p class="magick-description">reduce the speckles within an image.</p>
2441
2442<div style="margin: auto;">
2443 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2444</div>
2445
2446<p class="magick-description">render text right-to-left or left-to-right.</p>
2447
2448<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002449 <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 -04002450</div>
2451
2452<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2453
2454<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2455is used as a displacement map, which is used to displace the lookup of
2456what part of the 'background' image is seen at each point of the overlaid
2457area. Much like the displacement map is a 'lens' that redirects light shining
2458through it so as to present a distorted view the original 'background' image
2459behind it. </p>
2460
2461<p>Any perfect grey areas of the displacement map produce a zero
2462displacement of the image. Black areas produce the given maximum negative
2463displacement of the lookup point, while white produce a maximum positive
2464displacement of the lookup. </p>
2465
2466<p>Note that it is the lookup of the 'background' that is displaced, not a
2467displacement of the image itself. As such an area of the displacement map
2468containing 'white' will have the lookup point 'shifted' by a positive amount,
2469and thus generating a copy of the destination image to the right/downward from
2470the correct position. That is the image will look like it may have been
2471'shifted' in a negative left/upward direction. Understanding this is a very
2472important in understanding how displacement maps work. </p>
2473
2474<p>The given arguments define the maximum amount of displacement in pixels
2475that a particular map can produce. If the displacement scale is large enough
2476it is also possible to lookup parts of the 'background' image that lie well
2477outside the bounds of the displacement map itself. That is you could very
2478easily copy a section of the original image from outside the overlay area
2479into the overlay area. </p>
2480
2481<p>The '%' flag makes the displacement scale relative to the size of the
2482overlay image (100% = half width/height of image). Using '!' switches
2483percentage arguments to refer to the destination image size instead.
2484these flags were added as of IM v6.5.3-5.</p>
2485
2486<p>Normally a single grayscale displacement map is provided, which with the
2487given scaling values will determine a single direction (vector) in which
2488displacements can occur (positively or negatively). However, if you also
2489specify a third image which is normally used as a <var>mask</var>,
2490the <var>composite image</var> is used for horizontal X
2491displacement, while the <var>mask image</var> is used for vertical Y
2492displacement. This allows you to define completely different displacement
2493values for the X and Y directions, and allowing you to lookup any point within
2494the <var>scale</var> bounds. In other words each pixel can lookup
2495any other nearby pixel, producing complex 2 dimensional displacements, rather
2496than a simple 1 dimensional vector displacements. </p>
2497
2498<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2499you can use the 'red' channel of the overlay image to specify the horizontal
2500or X displacement, and the 'green' channel for the vertical or Y displacement.
2501</p>
2502
2503<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2504mask the transparency of the destination image. However areas outside the
2505overlaid areas will not be effected. </p>
2506
2507
2508<div style="margin: auto;">
2509 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2510</div>
2511
2512<p class="magick-description">Specifies the X server to contact.</p>
2513
2514<p>This option is used with convert for obtaining image or font from this
2515X server. See <var>X(1)</var>.</p>
2516
2517<div style="margin: auto;">
2518 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2519</div>
2520
2521<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2522
2523<p>The layer disposal method defines the way each the displayed image is to be
2524modified after the current 'frame' of an animation has finished being
2525displayed (after its 'delay' period), but before the next frame on an
2526animation is to be overlaid onto the display. </p>
2527
2528<p>Here are the valid methods:</p>
2529
2530<dl class="dl-horizontal">
2531<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2532<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2533<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2534<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2535</dl>
2536
2537<p>You can also use the numbers given above, which is what the GIF format
2538uses internally to represent the above settings. </p>
2539
2540<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2541
Cristy594d2772015-11-15 10:47:42 -05002542<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002543resetting the layer disposal methods of images being read in. </p>
2544
2545<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2546disposal method for images already in memory.</p>
2547
2548<div style="margin: auto;">
2549 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2550</div>
2551
2552<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2553
2554
2555<div style="margin: auto;">
2556 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2557</div>
2558
2559<p class="magick-description">dissolve an image into another by the given percent.</p>
2560
2561<p>The opacity of the composite image is multiplied by the given percent, then
2562it is composited 'over' the main image. If <var>src_percent</var>
2563is greater than 100, start dissolving the main image so it becomes
2564transparent at a value of '<code>200</code>'. If both percentages
2565are given, each image are dissolved to the percentages given. </p>
2566
2567<p>Note that dissolve percentages do not add, two opaque images dissolved
2568'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2569images, you would need to use dissolve values of '50,100'. </p>
2570
2571<div style="margin: auto;">
2572 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2573</div>
2574
2575<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2576
2577<p>The <var>arguments</var> is a single string containing a list
2578of floating point numbers separated by commas or spaces. The number of
2579and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2580
2581<p>Choose from these distortion types:</p>
2582
2583<table class="table table-condensed table-striped">
2584 <tr>
2585 <th style="width: 8%">Method</th>
2586 <th>Description</th>
2587 </tr>
2588
2589 <tr>
Cristy594d2772015-11-15 10:47:42 -05002590 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002591 <td>
2592 Distort image by first scaling and rotating about a given 'center',
2593 before translating that 'center' to the new location, in that order. It
2594 is an alternative method of specifying a 'Affine' type of
2595 distortion, but without shearing effects. It also provides a good way
2596 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002597 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002598
2599 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002600 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002601
2602 <dl class="dl-horizontal">
2603 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2604 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2605 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2606 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2607 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2608 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2609 </dl>
2610
2611 This is actually an alternative way of specifying a 2 dimensional linear
2612 'Affine' or 'AffineProjection' distortion. </td> </tr>
2613
2614 <tr>
2615 <td>Affine</td>
2616 <td>
2617 Distort the image linearly by moving a list of at least 3 or more sets
2618 of control points (as defined below). Ideally 3 sets or 12 floating
2619 point values are given allowing the image to be linearly scaled,
2620 rotated, sheared, and translated, according to those three points. See
2621 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002622 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002623
2624 More than 3 sets given control point pairs (12 numbers) is least
2625 squares fitted to best match a linear affine distortion. If only 2
2626 control point pairs (8 numbers) are given a two point image translation
2627 rotation and scaling is performed, without any possible shearing,
2628 flipping or changes in aspect ratio to the resulting image. If only one
2629 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002630 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002631
2632 This distortion does not include any form of perspective distortion.
2633 </td>
2634
2635 </tr>
2636
2637 <tr>
2638 <td>AffineProjection</td>
2639 <td>
2640 Linearly distort an image using the given Affine Matrix of 6
2641 pre-calculated coefficients forming a set of Affine Equations to map
2642 the source image to the destination image.
2643
2644 <p class="text-center"><var>
2645 s<sub>x</sub>, r<sub>x</sub>,
2646 r<sub>y</sub>, s<sub>y</sub>,
2647 t<sub>x</sub>, t<sub>y</sub>
2648 </var></p>
2649
Cristy594d2772015-11-15 10:47:42 -05002650 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2651 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002652
2653 The distortions 'Affine' and 'SRT' provide
2654 alternative methods of defining this distortion, with ImageMagick doing
2655 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002656 see the internally generated coefficients, by using a <a
2657 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002658
2659 </tr>
2660
2661 <tr>
Cristy594d2772015-11-15 10:47:42 -05002662 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002663 BilinearReverse</td>
2664 <td>
2665 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2666 16 values (see below). Not that lines may not appear straight after
2667 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002668 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002669
2670 The 'BilinearForward' is used to map rectangles to any
2671 quadrilateral, while the 'BilinearReverse' form maps any
2672 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002673 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002674
2675 Note that 'BilinearForward' can generate invalid pixels
Cristy594d2772015-11-15 10:47:42 -05002676 which will be colored using the <a href="command-line-options.html#mattecolor" >-mattecolor</a>
Cristy882d9f42015-10-29 16:48:39 -04002677 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002678 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002679
2680 There are future plans to produce a true Bilinear distortion that will
2681 attempt to map any quadrilateral to any other quadrilateral, while
2682 preserving edges (and edge distance ratios).
2683
2684 </td>
2685 </tr>
2686
2687 <tr>
2688 <td>Perspective</td>
2689 <td>
2690 Perspective distort the images, using a list of 4 or more sets of
2691 control points (as defined below). More that 4 sets (16 numbers) of
2692 control points provide least squares fitting for more accurate
2693 distortions (for the purposes of image registration and panorama
2694 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002695 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002696
2697 Perspective Distorted images ensures that straight lines remain
2698 straight, but the scale of the distorted image will vary. The horizon
2699 is anti-aliased, and the 'sky' color may be set using the
Cristy594d2772015-11-15 10:47:42 -05002700 <a href="command-line-options.html#mattecolor" >-mattecolor</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002701 </tr>
2702
2703 <tr>
2704 <td>PerspectiveProjection </td>
2705 <td>
2706 Do a 'Perspective' distortion biased on a set of 8
2707 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002708 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002709 'Perspective' distortion, or by calculating them yourself.
2710 If the last two perspective scaling coefficients are zero, the
2711 remaining 6 represents a transposed 'Affine Matrix'. </td>
2712
2713 </tr>
2714
2715 <tr>
2716 <td>Arc</td>
2717 <td>
2718 Arc the image (variation of polar mapping) over the angle given around
2719 a circle.
2720
Cristy594d2772015-11-15 10:47:42 -05002721 <p><dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002722 <dt>arc_angle</dt>
2723 <dd>The angle over which to arc the image side-to-side</dd>
2724 <dt>rotate_angle</dt>
2725 <dd>Angle to rotate resulting image from vertical center</dd>
2726 <dt>top_radius</dt>
2727 <dd>Set top edge of source image at this radius</dd>
2728 <dt>bottom_radius </dt>
2729 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy594d2772015-11-15 10:47:42 -05002730 </dl></p>
Cristy882d9f42015-10-29 16:48:39 -04002731
2732 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002733 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002734 preserve scale and aspect ratio of the original image as much as
2735 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002736 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002737
2738 This a variation of a polar distortion designed to try to preserve the
2739 aspect ratio of the image rather than direct Cartesian to Polar
2740 conversion. </td>
2741 </tr>
2742
2743 <tr>
2744 <td>Polar</td>
2745 <td>
2746 Like 'Arc' but do a complete Cartesian to Polar mapping of
2747 the image. that is the height of the input image is mapped to the
2748 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002749 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002750
Cristy594d2772015-11-15 10:47:42 -05002751 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002752
2753 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2754 center to the center of the image, and the angles going from -180 (top)
2755 to +180 (top). If <var>Rmax</var> is given the special value of
2756 '0', the the distance from the center to the nearest edge
2757 is used for the radius of the output image, which will ensure the whole
2758 image is visible (though scaled smaller). However a special value of
2759 '-1' will use the distance from the center to the furthest
2760 corner, This may 'clip' the corners from the input rectangular image,
2761 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002762 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002763
Cristy594d2772015-11-15 10:47:42 -05002764 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002765 output image center will default to 0,0 of the virtual
2766 canvas, and the image size adjusted to ensure the whole input image is
2767 made visible in the output image on the virtual canvas. </td>
2768
2769 </tr>
2770
2771 <tr>
2772 <td>DePolar</td>
2773 <td>
2774 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002775 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002776
2777 The special <var>Rmax</var> setting of '0' may however clip
2778 the corners of the input image. However using the special
2779 <var>Rmax</var> setting of '-1' (maximum center to corner
2780 distance) will ensure the whole distorted image is preserved in the
2781 generated result, so that the same argument to 'Polar' will
2782 reverse the distortion re-producing the original.
2783
2784 Note that as this distortion requires the area resampling of a circular
2785 arc, which can not be handled by the builtin EWA resampling function.
2786 As such the normal EWA filters are turned off. It is recommended some
2787 form of 'super-sampling' image processing technique be used to produce
2788 a high quality result. </td>
2789
2790 </tr>
2791
2792 <tr>
2793 <td>Barrel</td>
2794 <td>
Cristy594d2772015-11-15 10:47:42 -05002795 Given the four coefficients (A,B,C,D) as defined by <a
2796 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002797 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2798 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002799 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002800
2801 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002802 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002803 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2804 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2805 [ <var>X</var> , <var>Y</var> ] </p>
2806 So that it forms the function
2807 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2808 <var>C</var>*r + <var>D</var> )</p>
2809
2810 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002811 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002812 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002813 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002814 </td>
2815
2816 </tr>
2817
2818 <tr>
2819 <td>BarrelInverse</td>
2820 <td>
2821 This is very similar to 'Barrel' with the same set of
2822 arguments, and argument handling. However it uses the inverse
2823 of the radial polynomial,
2824 so that it forms the function
2825 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2826 <var>C</var>*r + <var>D</var> )</p>
2827 Note that this is not the reverse of the 'Barrel'
2828 distortion, just a different barrel-like radial distortion method.
2829
2830 </td>
2831 </tr>
2832
2833 <tr>
2834 <td>Shepards</td>
2835 <td>
2836 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05002837 Squared Distance Interpolation Method (<a
2838 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04002839 Method</a>). The control points in effect do 'localized' displacement
2840 of the image around the given control point (preserving the look and
2841 the rotation of the area near the control points. For best results
2842 extra control points should be added to 'lock' the positions of the
2843 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05002844 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002845
2846 The distortion has been likened to 'taffy pulling' using nails, or
2847 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05002848 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002849
Cristy594d2772015-11-15 10:47:42 -05002850 Internally it is equivalent to generating a displacement map (see <a
2851 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
2852 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04002853
2854 </td>
2855 </tr>
2856
2857</table>
2858
2859<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2860distort</a>.</p>
2861
2862<p>Many of the above distortion methods such as '<code>Affine</code>',
2863'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
2864defining how these points in the given image should be distorted in the
2865destination image. Each set of four floating point values represent a source
2866image coordinate, followed immediately by the destination image coordinate.
2867This produces a list of values such as...</p>
2868<p class="text-center"><var>
2869 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
2870 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
2871 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
2872 ...
2873 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
2874</var></p>
2875<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
2876destination image. </p>
2877
2878<p>For example, to warp an image using '<code>perspective</code>' distortion,
2879needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2880perspective distortion of the built-in "rose:" image. Note how spaces were
2881used to group the 4 sets of coordinate pairs, to make it easier to read and
2882understand.</p>
2883
2884<pre>
2885convert rose: -virtual-pixel black \
2886 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
2887 rose_3d_rotated.gif"
2888</pre>
2889
2890<p>If more that the required number of coordinate pairs are given for
2891a distortion, the distortion method is 'least squares' fitted to produce the
2892best result for all the coordinate pairs given. If less than the ideal number
2893of points are given, the distort will generally fall back to a simpler form of
2894distortion that can handles the smaller number of coordinates (usually a linear
2895'<code>Affine</code>' distortion). </p>
2896
2897<p>By using more coordinates you can make use of image registration tool to
2898find matching coordinate pairs in overlapping images, so as to improve the
2899'fit' of the distortion. Of course a bad coordinate pair can also make the
2900'fit' worse. Caution is always advised. </p>
2901
2902<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05002903resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04002904EWA resampling. This produces very high quality results, especially when
2905images become smaller (minified) in the output, which is very common when
2906using '<code>perspective</code>' distortion. For example here we view
2907a infinitely tiled 'plane' all the way to the horizon. </p>
2908
2909<pre>
2910convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
2911 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
2912 checks_tiled.jpg
2913</pre>
2914
2915<p>Note that a infinitely tiled perspective images involving the horizon can
2916be very slow, because of the number of pixels that are compressed to generate
2917each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05002918resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04002919'<code>point</code>' (recommended if you plan to use super-sampling instead).
2920</p>
2921
2922<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05002923example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
2924href="command-line-options.html#mattecolor" >-mattecolor</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04002925what these pixels to be visible, set the color to match the rest of the
2926ground. </p>
2927
2928<p>The output image size will by default be the same as the input image. This
2929means that if the part of the distorted image falls outside the viewed area of
2930the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05002931the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04002932will attempt (if possible) to show the whole of the distorted image, while
2933retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05002934may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04002935is unwanted. </p>
2936
Cristy594d2772015-11-15 10:47:42 -05002937<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
2938href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
2939and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04002940and debugging purposes. This many not be available for all distorts. </p>
2941
Cristy594d2772015-11-15 10:47:42 -05002942<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
2943>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04002944specify the size and the offset of the generated 'viewport' image of the
2945distorted image space.</p>
2946
Cristy594d2772015-11-15 10:47:42 -05002947<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy882d9f42015-10-29 16:48:39 -04002948distort:scale={scale_factor}</code>" will scale the output image (viewport or
2949otherwise) by that factor without changing the viewed contents of the
2950distorted image. This can be used either for 'super-sampling' the image for
2951a higher quality result, or for panning and zooming around the image (with
2952appropriate viewport changes, or post-distort cropping and resizing). </p>
2953
Cristy594d2772015-11-15 10:47:42 -05002954<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04002955will output the cylindrical filter lookup table created by the EWA (Elliptical
2956Weighted Average) resampling algorithm. Note this table uses a squared radius
2957lookup value. This is typically only used for debugging EWA resampling. </p>
2958
2959
2960<div style="margin: auto;">
2961 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
2962</div>
2963
2964<p class="magick-description">launch a distributed pixel cache server. </p>
2965
2966<div style="margin: auto;">
2967 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
2968</div>
2969
2970<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
2971images when general color reduction is applied via an option, or automagically
2972when saving to specific formats. This enabled by default.</p>
2973
2974<p>Dithering places two or more colors in neighboring pixels so that to the
2975eye a closer approximation of the images original color is reproduced. This
2976reduces the number of colors needed to reproduce the image but at the cost of
2977a lower level pattern of colors. Error diffusion dithers can use any set of
2978colors (generated or user defined) to an image. </p>
2979
2980<p>Dithering is turned on by default, to turn it off use the plus form of the
2981setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
2982without text or graphic aliasing. Disabling dithering often (but not always)
2983leads to faster process, a smaller number of colors, but more cartoon like
2984image coloring. Generally resulting in 'color banding' effects in areas with
2985color gradients. </p>
2986
Cristy594d2772015-11-15 10:47:42 -05002987<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
2988href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
2989href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04002990color set they created. These operators are also used as part of automatic
2991color reduction when saving images to formats with limited color support, such
2992as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
2993in these cases. </p>
2994
2995<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05002996to generate purely random dither. Or use <a
2997href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04002998patterns, using uniform color maps, rather than specific color maps. </p>
2999
3000
3001<div style="margin: auto;">
3002 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3003</div>
3004
3005<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3006
3007<p>Use this option to annotate or decorate an image with one or more graphic
3008primitives. The primitives include shapes, text, transformations, and pixel
3009operations.</p>
3010
3011<p>The shape primitives:</p>
3012
3013<dl class="dl-horizontal">
3014<dt>point</dt><dd> x,y</dd>
3015<dt>line</dt><dd> x0,y0 x1,y1</dd>
3016<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3017<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3018<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3019<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3020<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3021<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3022<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3023<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3024<dt>path</dt><dd>specification </dd>
3025<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3026</dl>
3027
3028<p>The text primitive:</p>
3029
3030<dl class="dl-horizontal">
3031<dt>text</dt><dd>x0,y0 string</dd>
3032</dl>
3033<p>The text gravity primitive:</p>
3034
3035<dl class="dl-horizontal">
3036<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3037</dl>
3038
3039<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003040interact with the other primitives. It is equivalent to using the <a
3041href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003042scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3043
3044<p>The transformation primitives:</p>
3045
3046<dl class="dl-horizontal">
3047<dt>rotate</dt><dd>degrees</dd>
3048<dt>translate</dt><dd>dx,dy</dd>
3049<dt>scale</dt><dd>sx,sy</dd>
3050<dt>skewX</dt><dd>degrees</dd>
3051<dt>skewY</dt><dd>degrees</dd>
3052</dl>
3053
3054<p>The pixel operation primitives:</p>
3055
3056<dl class="dl-horizontal">
3057<dt>color</dt><dd>x0,y0 method</dd>
3058<dt>matte</dt><dd>x0,y0 method</dd>
3059</dl>
3060
Cristy594d2772015-11-15 10:47:42 -05003061<p>The shape primitives are drawn in the color specified by the preceding <a
3062href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3063href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3064"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3065href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003066
3067<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3068pixel plane, that is, by an ordered pair of integer coordinates,
3069<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003070primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3071href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003072
3073<p>A <code>line</code> primitive requires a start point and end point.</p>
3074
3075<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3076upper left and lower right corners.</p>
3077
3078<p>A <code>roundRectangle</code> primitive takes the same corner points as
3079a <code>rectangle</code> followed by the width and height of the rounded corners
3080to be removed.</p>
3081
3082<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3083Give the center and any point on the perimeter (boundary).</p>
3084
3085<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3086to a given rectangle. An <code>arc</code> requires the two corners used for
3087<code>rectangle</code> (see above) followed by the start and end angles of the
3088arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3089points produced are then joined with a line segment and the resulting segment
3090of an ellipse is filled.</p>
3091
3092<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3093center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3094the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
30950,360).</p>
3096
3097<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3098more points to define their perimeters. A <code>polyline</code> is simply
3099a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003100point. When unfilled, this is a <var>polygonal line</var>. If the <a
3101href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003102a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3103
3104<p>A <var>coordinate</var> is a pair of integers separated by a space or
3105optional comma. </p>
3106
3107<p>As an example, to define a circle centered at 100,100 that extends to
3108150,150 use:</p>
3109
3110<pre>
3111-draw 'circle 100,100 150,150'
3112</pre>
3113
3114<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3115or points to define its shape. The first and last points are the
3116<var>knots</var> and these points are attained by the curve, while any
3117intermediate coordinates are <var>control points</var>. If two control points
3118are specified, the line between each end knot and its sequentially respective
3119control point determines the tangent direction of the curve at that end. If
3120one control point is specified, the lines from the end knots to the one
3121control point determines the tangent directions of the curve at each end. If
3122more than two control points are specified, then the additional control points
3123act in combination to determine the intermediate shape of the curve. In order
3124to draw complex curves, it is highly recommended either to use the
3125<code>path</code> primitive or to draw multiple four-point bezier segments with
3126the start and end knots of each successive segment repeated. For example:</p>
3127
3128<pre>
3129-draw 'bezier 20,50 45,100 45,0 70,50'
3130-draw 'bezier 70,50 95,100 95,0 120,50'
3131</pre>
3132
3133<p>A <code>path</code> represents an outline of an object, defined in terms of
3134moveto (set a new current point), lineto (draw a straight line), curveto (draw
3135a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3136current shape by drawing a line to the last moveto) elements. Compound paths
3137(i.e., a path with subpaths, each consisting of a single moveto followed by
3138one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003139<var>donut holes</var> in objects. (See <a
3140href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003141
3142<p>Use <code>image</code> to composite an image with another image. Follow the
3143image keyword with the composite operator, image location, image size, and
3144filename:</p>
3145
3146<pre>
3147-draw 'image SrcOver 100,100 225,225 image.jpg'
3148</pre>
3149
3150<p>You can use 0,0 for the image size, which means to use the actual
3151dimensions found in the image header. Otherwise, it is scaled to the given
3152dimensions. See <a href="compose.html">Alpha Compositing</a> for
3153a detailed discussion of alpha composition methods that are available. </p>
3154
3155<p>The "special augmented compose operators" such as "dissolve" that require
3156arguments cannot be used at present with the <code>-draw image</code> option.
3157 </p>
3158
3159<p>Use <code>text</code> to annotate an image with text. Follow the text
3160coordinates with a string. If the string has embedded spaces, enclose it in
3161single or double quotes.</p>
3162
3163<p>For example, the following annotates the image with <code>Works like
3164magick!</code> for an image titled <code>bird.miff</code>. </p>
3165
3166<pre>
3167-draw "text 100,100 'Works like magick!' "
3168</pre>
3169
3170<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3171to annotate an image with text.</p>
3172
3173<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003174text primitives about the origin of the main image. If the <a
3175href="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 -04003176option, the origin for transformations is the upper left corner of the
3177region.</p>
3178
3179<p>The <code>translate</code> primitive translates subsequent shape and text
3180primitives.</p>
3181
3182<p>The <code>scale</code> primitive scales them.</p>
3183
3184<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3185to the origin of the main image or the region.</p>
3186
3187<p>The transformations modify the current affine matrix, which is initialized
3188from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3189option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3190option. The initial affine matrix is not affected; that matrix is only changed
3191by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3192<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3193reinitialized from the initial affine matrix.</p>
3194
3195<p>Use the <code>color</code> primitive to change the color of a pixel to the
3196fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3197a method:</p>
3198
3199<pre>
3200point
3201replace
3202floodfill
3203filltoborder
3204reset
3205</pre>
3206
3207<p>Consider the target pixel as that specified by your coordinate. The
3208<code>point</code> method recolors the target pixel. The <code>replace</code>
3209method recolors any pixel that matches the color of the target pixel.
3210<code>Floodfill</code> recolors any pixel that matches the color of the target
3211pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3212pixel that is not the border color. Finally, <code>reset</code> recolors all
3213pixels.</p>
3214
3215<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3216Follow the pixel coordinate with a method (see the <code>color</code> primitive
3217for a description of methods). The <code>point</code> method changes the matte
3218value of the target pixel. The <code>replace</code> method changes the matte
3219value of any pixel that matches the color of the target pixel.
3220<code>Floodfill</code> changes the matte value of any pixel that matches the
3221color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003222changes the matte value of any neighbor pixel that is not the border color (<a
3223href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003224matte value of all pixels.</p>
3225
Cristy594d2772015-11-15 10:47:42 -05003226<p>You can set the primitive color, font, and font bounding box color with <a
3227href="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 -04003228respectively. Options are processed in command line order so be sure to use
3229these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3230
3231<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3232than 1.png).</p>
3233
Cristy594d2772015-11-15 10:47:42 -05003234<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003235Vector Graphics</a> format.</p>
3236
3237
3238<div style="margin: auto;">
3239 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3240</div>
3241
3242<p class="magick-description">duplicate an image one or more times.</p>
3243
3244<p>Specify the count and the image to duplicate by its index in the sequence.
3245The first image is index 0. Negative indexes are relative to the end of the
3246sequence, for example, -1 represents the last image of the sequence. Specify
3247a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
32480,2). Use <code>+duplicate</code> to duplicate the last image in the current
3249image sequence.</p>
3250
3251<div style="margin: auto;">
3252 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3253</div>
3254
3255<p class="magick-description">detect edges within an image.</p>
3256
3257<div style="margin: auto;">
3258 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3259</div>
3260
3261<p class="magick-description">emboss an image.</p>
3262
3263<div style="margin: auto;">
3264 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3265</div>
3266
3267<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3268
3269<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3270
Cristy594d2772015-11-15 10:47:42 -05003271<p>For more information, see the webpage, <a
3272href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003273Decipher an Image</a>.</p>
3274
3275
3276
3277<div style="margin: auto;">
3278 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3279</div>
3280
3281<p class="magick-description">specify the text encoding.</p>
3282
3283<p>Choose from</p>
3284
3285<pre>
3286AdobeCustom AdobeExpert
3287AdobeStandard AppleRoman
3288BIG5 GB2312
3289Latin 2 None
3290SJIScode Symbol
3291Unicode Wansung
3292</pre>
3293
3294<div style="margin: auto;">
3295 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3296</div>
3297
3298<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3299
3300<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3301
3302<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3303
3304
3305<div style="margin: auto;">
3306 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3307</div>
3308
3309<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3310
3311
3312<div style="margin: auto;">
3313 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3314</div>
3315
3316<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3317
3318<p>To perform histogram equalization on all channels in concert, transform the
3319image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3320equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3321
3322<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3323-equalize -colorspace RGB</code> ...</p>
3324
3325<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3326components transformation that puts most of the information in the first
3327channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3328-colorspace RGB</code> ...</p>
3329
3330<div style="margin: auto;">
3331 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3332</div>
3333
3334<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3335
Cristy594d2772015-11-15 10:47:42 -05003336<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3337multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003338elaborate calculations are needed.)</p>
3339
3340<p>The behaviors of each <var>operator</var> are summarized in the
3341following list. For brevity, the numerical value of a "pixel" referred to
3342below is the value of the corresponding channel of that pixel, while
3343a "normalized pixel" is that number divided by the maximum
3344(installation-dependent) value <var>QuantumRange</var>. (If
3345normalized pixels are used, they are restored, following the other
3346calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3347
3348<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003349 <col width="25%" />
3350 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003351 <thead>
3352 <tr>
3353 <th><var>operator</var></th>
3354 <th>Summary (see further below for details)</th>
3355 </tr>
3356 </thead>
3357 <tbody>
3358
3359 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3360 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3361 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3362 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3363 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3364 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3365 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3366 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3367 <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>
3368 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3369 <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>
3370 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3371 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3372 <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>
3373 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3374 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3375 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3376 <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>
3377 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3378 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3379 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3380 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3381 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3382 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3383
3384 <tr><td> </td><td> </td></tr>
3385
3386 <tr><td>Gaussian-noise</td><td> </td></tr>
3387 <tr><td>Impulse-noise</td><td> </td></tr>
3388 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003389 <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 -04003390 <tr><td>PoissonNoise</td><td> </td></tr>
3391 <tr><td>Uniform-noise</td><td> </td></tr>
3392
3393 <tr><td> </td><td> </td></tr>
3394
3395 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3396 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3397 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3398 </tbody>
3399 </table>
3400
Cristy594d2772015-11-15 10:47:42 -05003401<p>The specified functions are applied only to each previously set <a
3402href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003403calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3404represented as a 'alpha' values (0 = fully transparent), so, for example, a
3405<code>Divide</code> by 2 of the alpha channel will make the image
3406semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3407as a percentage of the <var>QuantumRange</var>.</p>
3408
3409<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3410<a href="command-line-options.html#list">-list evaluate</a>.</p>
3411
3412<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003413<code>Multiply</code> methods can also be achieved using either the <a
3414href="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 -04003415appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003416Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3417'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003418'alpha' values.</p>
3419
3420<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3421addition modulo the <var>QuantumRange</var>. It is therefore
3422equivalent to <code>Add</code> unless the resulting pixel value is outside the
3423interval [0, <var>QuantumRange</var>]. </p>
3424
3425<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3426works on normalized pixel values. The <var>value</var> used with
3427<code>Exp</code> should be negative so as to produce a decaying exponential
3428function. Non-negative values will always produce results larger unity and
3429thus outside the interval [0, <var>QuantumRange</var>]. The
3430formula is expressed below. </p>
3431
3432<p class="text-center">
3433exp(<var>value</var> × <b><var>u</var></b>)
3434</p>
3435
Cristy594d2772015-11-15 10:47:42 -05003436<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3437>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003438the result.</p>
3439
3440<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3441normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3442factor</var> that adjusts the curvature in the graph of the log function. The
3443formula applied to a normalized value <b><var>u</var></b> is below. </p>
3444
3445<p class="text-center">
3446log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3447</p>
3448
3449<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003450normalized pixel values. Note that <code>Pow</code> is related to the <a
3451href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003452to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003453with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003454with <code>Pow</code>.</p>
3455
3456<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3457converts the image values into a value according to a (co)sine wave function.
3458The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3459is biased 50% and normalized by 50% so as to fit in the respective color value
3460range. The <var>value</var> scaling of the <var>period</var> of the
3461function (its frequency), and thus determines the number of 'waves' that will
3462be 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,
3463then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3464
3465<p class="text-center">
34660.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3467</p>
3468
Cristy594d2772015-11-15 10:47:42 -05003469<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003470multi-value version of evaluate. </p>
3471
3472<div style="margin: auto;">
3473 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3474</div>
3475
3476<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3477logical expression over a sequence of images.</p>
3478
Cristy594d2772015-11-15 10:47:42 -05003479<p>To print a complete list of <a
3480href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3481href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003482
3483<div style="margin: auto;">
3484 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3485</div>
3486
3487<p class="magick-description">Set the image size and offset.</p>
3488
3489<p>If the image is enlarged, unfilled areas are set to the background color.
3490To position the image, use offsets in the <var>geometry</var>
3491specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003492specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3493>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003494
3495<p>This command reduces or expands a JPEG image to fit on an 800x600
3496display. If the aspect ratio of the input image isn't exactly 4:3, then the
3497image is centered on an 800x600 black canvas: </p>
3498
3499<pre>
3500convert input.jpg -resize 800x600 -background black -compose Copy \
3501 -gravity center -extent 800x600 -quality 92 output.jpg
3502</pre>
3503
3504<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3505
3506<div style="margin: auto;">
3507 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3508</div>
3509
3510<p class="magick-description">Extract the specified area from image.</p>
3511
3512<p>This option is most useful for extracting a subregion of a very large raw
3513image. Note that these two commands are equivalent:</p>
3514
3515<pre>
3516convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3517 image.rgb image.png",
3518convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3519 image.rgb image.png"
3520</pre>
3521
3522<p>If you omit the offsets, as in</p>
3523
3524<pre>
3525convert -size 16000x16000 -depth 8 -extract 640x480 \
3526 image.rgb image.png
3527</pre>
3528
3529<p>the image is <var>resized</var> to the specified dimensions instead,
3530equivalent to:</p>
3531
3532<pre>
3533convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3534</pre>
3535
3536<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3537
3538<div style="margin: auto;">
3539 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3540</div>
3541
3542<p class="magick-description">Set a font family for text.</p>
3543
3544<p>This setting suggests a font family that ImageMagick should try to use for
3545rendering text. If the family can be found it is used; if not, a default font
3546(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3547"Courier" might be used if "System" is requested but not found). </p>
3548
Cristy594d2772015-11-15 10:47:42 -05003549<p>For other settings that affect fonts, see the options <a
3550href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3551href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003552
3553<div style="margin: auto;">
3554 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3555</div>
3556
3557<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>
3558
3559<pre>
3560Angular Second Moment Sum Entropy
3561Contrast Entropy
3562Correlation Difference Variance
3563Sum of Squares Variance Difference Entropy
3564Inverse Difference Moment Information Measure of Correlation 1
3565Sum Average Information Measure of Correlation 2
3566Sum Variance Maximum Correlation Coefficient
3567</pre>
3568
3569<div style="margin: auto;">
3570 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3571</div>
3572
3573<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3574
3575<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3576users in ImageMagick 6.6.0-9). It transforms an image from the normal
3577(spatial) domain to the frequency domain. In the frequency domain, an image is
3578represented as a superposition of complex sinusoidal waves of varying
3579amplitudes. The image x and y coordinates are the possible frequencies along
3580the x and y directions, respectively, and the pixel intensity values are
3581complex numbers that correspond to the sinusoidal wave amplitudes. See for
3582example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3583Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3584Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3585Transform</a>.</p>
3586
3587<p>A single image name is provided as output for this option. However, the
3588output result will have two components. It is either a two-frame image or two
3589separate images, depending upon whether the image format specified supports
3590multi-frame images. The reason that we get a dual output result is because the
3591frequency domain represents an image using complex numbers, which cannot be
3592visualized directly. Therefore, the complex values are automagically separated
3593into a two-component image representation. The first component is the
3594magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003595number. See for example, <a
3596href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003597
3598<p>The magnitude and phase component images must be specified using image
3599formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3600PFM, EXR and PNG are the recommended image formats to use. All of these
3601formats, except PNG support multi-frame images. So for example,</p>
3602
3603<pre>
3604convert image.png -fft fft_image.miff
3605</pre>
3606
3607<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3608image as <code>fft_image.miff[1]</code>. Similarly,</p>
3609
3610<pre>
3611convert image.png -fft fft_image.png
3612</pre>
3613
3614<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3615as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003616force any of the other formats to produce two output images by including <a
3617href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003618
3619<p>The input image can be any size, but if not square and even-dimensioned, it
3620is padded automagically to the larger of the width or height of the input
3621image and to an even number of pixels. The padding will occur at the bottom
3622and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003623phase images is square at this size. The kind of padding relies on the <a
3624href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003625
3626<p>Both output components will have dynamic ranges that fit within
3627[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3628Phase values nominally range from 0 to 2*π, but is scaled to span the full
3629dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3630scaled). The magnitude image is not scaled and thus generally will contain
3631very small values. As such, the image normally will appear totally black. In
3632order to view any detail, the magnitude image typically is enhanced with a log
3633function into what is usually called the spectrum. A log function is used to
3634enhance the darker values more in comparison to the lighter values. This can
3635be done, for example, as follows:</p>
3636
3637<pre>
3638convert fft_image.miff[0] -contrast-stretch 0 \
3639 -evaluate log 1000 fft_image_spectrum.png"
3640</pre>
3641
Cristy594d2772015-11-15 10:47:42 -05003642<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3643href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003644range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3645typically is specified between 100 and 10,000, depending upon the amount of
3646detail that one wants to bring out in the spectrum. Larger values produce more
3647visible detail. Too much detail, however, may hide the important features.</p>
3648
3649<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3650use <a href="command-line-options.html#fft">-fft</a>.</p>
3651
3652<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3653and imaginary components of the complex valued Fourier transform.</p>
3654
3655<p>However, as the real and imaginary components can contain negative values,
3656this requires that IM be configured with HDRI enabled. In this case, you must
3657use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3658results, since they are formats that preserve both negative and fractional
3659values without clipping them or truncating the fractional part. With either
3660MIFF or TIF, one should add -define quantum:format=32, to allow those image
3661types to work properly in HDRI mode without clipping.</p>
3662
Cristy594d2772015-11-15 10:47:42 -05003663<p>The real and imaginary component images resulting from <a
3664href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003665padding that was discussed above for the magnitude and phase component
3666images.</p>
3667
Cristy594d2772015-11-15 10:47:42 -05003668<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3669href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3670about HDRI go the ImageMagick <a
3671href="http://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
3672href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3673>Fred's Fourier Processing With ImageMagick page</a> or this <a
3674 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003675 entry. </p>
3676
Cristy594d2772015-11-15 10:47:42 -05003677<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 -04003678
3679
3680<div style="margin: auto;">
3681 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3682</div>
3683
3684<p class="magick-description">color to use when filling a graphic primitive.</p>
3685
3686<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003687HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003688a description of how to properly specify the color argument.</p>
3689
3690<p>Enclose the color specification in quotation marks to prevent the "#" or
3691the parentheses from being interpreted by your shell.</p>
3692
3693<p>For example,</p>
3694
3695<pre>
3696-fill blue
3697-fill "#ddddff"
3698-fill "rgb(255,255,255)"
3699</pre>
3700
3701<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3702
3703<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3704
3705<div style="margin: auto;">
3706 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3707</div>
3708
3709<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3710
3711<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003712operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3713>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003714
3715<pre>
3716Point Hermite Cubic
3717Box Gaussian Catrom
3718Triangle Quadratic Mitchell
3719</pre>
3720
3721<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3722as a faster <code>SincFast</code> equivalent form). However these filters are
3723generally useless on their own as they are infinite filters that are being
3724clipped to the filters support size. Their direct use is not recommended
3725except via expert settings (see below). </p>
3726
3727<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003728function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003729using these functions will define a 'Windowed' filter, appropriate to the
3730operator involved. Windowed filters include: </p>
3731
3732<pre>
3733Lanczos Hamming Parzen
3734Blackman Kaiser Welsh
3735Hanning Bartlett Bohman
3736</pre>
3737
3738<p>Also one special self-windowing filter is also provided
3739<code>Lagrange</code>, which will automagically re-adjust its function depending
3740on the current 'support' or 'lobes' expert settings (see below).</p>
3741
3742<p>If you do not select a filter with this option, the filter defaults to
3743<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3744if the image is enlarged. Otherwise the filter default to
3745<code>Lanczos</code>.</p>
3746
3747<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3748filter</a> option.</p>
3749
3750<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003751use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3752href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003753
3754<table class="table table-condensed table-striped">
3755 <tr>
3756 <td>-define filter:blur=<var>factor</var></td>
3757 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3758 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3759 Gaussian-like filters simple filters, or you may not get the expected
3760 results. </td>
3761 </tr>
3762
3763 <tr>
3764 <td>-define filter:support=<var>radius</var></td>
3765 <td>Set the filter support radius. Defines how large the filter should be and
3766 thus directly defines how slow the filtered resampling process is. All
3767 filters have a default 'preferred' support size. Some filters like
3768 <code>Lagrange</code> and windowed filters adjust themselves depending on
3769 this value. With simple filters this value either does nothing (but slow
3770 the resampling), or will clip the filter function in a detrimental way.
3771 </td>
3772 </tr>
3773
3774 <tr>
3775 <td>-define filter:lobes=<var>count</var></td>
3776 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3777 alternative way of specifying the 'support' range of the filter, that is
3778 designed to be more suited to windowed filters, especially when used for
3779 image distorts.</td>
3780 </tr>
3781
3782 <tr>
3783 <td>-define filter:sigma=<var>value</var></td>
3784 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3785 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3786 does not shrink (but may enlarge) the filter's 'support'. It can be used
3787 to generate very small blurs but without the filter 'missing' pixels due
3788 to using a small support setting. A larger value of '<code>0.707</code>'
3789 (a value of '1/sqrt(2)') is another common setting. </td>
3790 </tr>
3791
3792 <tr>
3793 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy594d2772015-11-15 10:47:42 -05003794 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003795 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3796 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3797 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3798 the <code>Parzen</code> cubic windowing function. If only one of the values
3799 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3800 The values meaning was defined by a research paper by
3801 Mitchell-Netravali.</td>
3802 </tr>
3803
3804 <tr>
3805 <td>-define filter:kaiser-beta=<var>value</var></td>
3806 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3807 Default value is '6.5'. It only effects Kaiser windowing function, and
3808 does not effect any other attributes.
3809 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3810 inheritance from the very old "zoom" program). It was changed to bring the
3811 function in line with more modern academic research usage, and better
3812 assign it be more definitive. </td>
3813 </tr>
3814
3815 <tr>
3816 <td>-define filter:kaiser-alpha=<var>value</var></td>
3817 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3818 will override that setting. It only effects Kaiser windowing function,
3819 and does not effect any other attributes. </td>
3820 </tr>
3821
3822 <tr>
3823 <td>-define filter:filter=<var>filter_function</var></td>
3824 <td>Use this function directly as the weighting filter. This will allow
3825 you to directly use a windowing function such as <code>Blackman</code>,
3826 as a resampling filter, rather than as its normal usage as a windowing
3827 function. If defined, no windowing function also defined, the window function is set
3828 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3829 as a filter will also do this. </td>
3830 </tr>
3831
3832 <tr>
3833 <td>-define filter:window=<var>filter_function</var></td>
3834 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
3835 <code>Jinc</code> are windowed (brought down to zero over the defined
3836 support range) with the given filter. This allows you to specify a filter
3837 function to be used as a windowing function for these IIR filters.
3838 Many of the defined filters are actually windowing functions for these IIR
3839 filters. A typical choices is <code>Box</code>, (which effectively turns
3840 off the windowing function). </td>
3841 </tr>
3842
3843 <tr>
3844 <td>-define filter:win-support=<var>radius</var></td>
3845 <td>Scale windowing function to this size instead. This causes the windowing
3846 (or self-windowing Lagrange filter) to act is if the support window is
3847 larger than what is actually supplied to the calling operator. The filter
3848 however is still clipped to the real support size given. If unset this
3849 will equal the normal filter support size. </td>
3850 </tr>
3851
3852 <tr>
3853 <td>-define filter:verbose=<var>1</var></td>
3854 <td>This causes IM to print information on the final internal filter
3855 selection to standard output. This includes a commented header on the
3856 filter settings being used, and data allowing the filter weights to be
3857 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
3858 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
3859 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
3860 with specific 'B' and 'C' settings. </td>
3861 </tr>
3862
3863</table>
3864
3865<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
3866
3867<pre>
3868convert image.png \
3869 -filter sinc \
3870 -set filter:window=jinc \
3871 -set filter:lobes=8 \
3872 -resize 150% image.jpg"
3873</pre>
3874
3875<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3876
3877<pre>
3878convert image.png \
3879 -set filter:filter=sinc \
3880 -set filter:lobes=4 \
3881 -resize 150% image.jpg"
3882</pre>
3883
3884<p>To extract the data for a raw windowing function, combine it with
3885a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
3886windowing function. </p>
3887
3888<pre>
3889convert null: -define filter:filter=Box \
3890 -define filter:window=Welch \
3891 -define filter:support=1.0 \
3892 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05003893 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04003894gnuplot
3895 set grid
3896 plot \"window_welch.dat\" with lines
3897</pre>
3898
3899<p>Note that the use of expert options is provided for image processing experts
3900who have studied and understand how resize filters work. Without this
3901knowledge, and an understanding of the definition of the actual filters
3902involved, using expert settings are more likely to be detrimental to your image
3903resizing.</p>
3904
3905
3906<div style="margin: auto;">
3907 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
3908</div>
3909
Cristy594d2772015-11-15 10:47:42 -05003910<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 -04003911
3912
3913<div style="margin: auto;">
3914 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
3915</div>
3916
3917<p class="magick-description">create a <var>mirror image</var></p>
3918
3919<p>reflect the scanlines in the vertical direction. The image will be mirrored
3920upside-down. </p>
3921
3922
3923<div style="margin: auto;">
3924 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
3925</div>
3926
3927<p class="magick-description">floodfill the image with color at the specified offset.</p>
3928
3929<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05003930Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04003931given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05003932will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04003933
3934<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05003935<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04003936action will be taken. </p>
3937
Cristy594d2772015-11-15 10:47:42 -05003938<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04003939a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05003940point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04003941its 'color floodfill' drawing method. </p>
3942
3943
3944<div style="margin: auto;">
3945 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
3946</div>
3947
3948<p class="magick-description">create a <var>mirror image</var>.</p>
3949
3950<p>Reflect the scanlines in the horizontal direction, just like the image in
3951a vertical mirror. </p>
3952
3953
3954<div style="margin: auto;">
3955 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
3956</div>
3957
3958<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
3959
3960<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
3961option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
3962
3963<p>In addition to the fonts specified by the above pre-defined list, you can
3964also specify a font from a specific source. For example <code>Arial.ttf</code>
3965is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
3966<code>x:fixed</code> is X11 font.</p>
3967
Cristy594d2772015-11-15 10:47:42 -05003968<p>For other settings that affect fonts, see the options <a
3969href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3970href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003971
3972
3973<div style="margin: auto;">
3974 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
3975</div>
3976
3977<p class="magick-description">Define the foreground color for menus.", "display</p>
3978
Cristy594d2772015-11-15 10:47:42 -05003979<p>The color is specified using the format described under the <a
3980href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04003981
3982<p>The default foreground color is black.</p>
3983
3984<div style="margin: auto;">
3985 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
3986</div>
3987
3988<p class="magick-description">the image format type.</p>
3989
3990<p>When used with the <code>mogrify</code> utility, this option converts any
3991image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05003992For a list of image format types supported by ImageMagick, use <a
3993href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003994
3995<p>By default the file is written to its original name. However, if the
3996filename extension matches a supported format, the extension is replaced with
3997the image format type specified with <a href="command-line-options.html#format">-format</a>. For
3998example, if you specify <var>tiff</var> as the format type and the
3999input image filename is <var>image.gif</var>, the output image
4000filename becomes <var>image.tiff</var>.</p>
4001
4002<div style="margin: auto;">
4003 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4004</div>
4005
4006<p class="magick-description">output formatted image characteristics.</p>
4007
4008<p>See <a href="escape.html">Format and Print Image
4009Properties</a> for an explanation on how to specify the argument to this
4010option.</p>
4011
4012<div style="margin: auto;">
4013 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4014</div>
4015
4016<p class="magick-description">Surround the image with a border or beveled frame.</p>
4017
Cristy594d2772015-11-15 10:47:42 -05004018<p>The color of the border is specified with the <a href="command-line-options.html#mattecolor"
4019>-mattecolor</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004020
4021<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
4022height that is added to the dimensions of the image. If no offsets are given
4023in the <var>geometry</var> argument, then the border added is
4024a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4025the width and height of the border is partitioned to form an outer bevel of
4026thickness <var>x</var> pixels and an inner bevel of thickness
4027<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4028</p>
4029
Cristy594d2772015-11-15 10:47:42 -05004030<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4031href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004032'<code>Over</code>' composition method. It generates an image of the appropriate
4033size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004034draws the frame of four distinct colors close to the current <a
4035href="command-line-options.html#mattecolor">-mattecolor</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004036center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004037'<code>Over</code>' any transparent parts may be replaced by the current <a
4038href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004039
4040<p>The image composition is not
4041affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4042
4043
4044<div style="margin: auto;">
4045 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4046</div>
4047
4048<p class="magick-description">include the X window frame in the imported image. </p>
4049<div style="margin: auto;">
4050 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4051</div>
4052
4053<p class="magick-description">Apply a function to channel values.</p>
4054
4055<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004056each of the color values for each previously set <a
4057href="command-line-options.html#channel">-channel</a> in the image. See <a
4058href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004059calculations are handled.</p>
4060
Cristy594d2772015-11-15 10:47:42 -05004061<p>This is can be considered a multi-argument version of the <a
4062href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004063ImageMagick 6.4.8−8.)</p>
4064
4065<p>Here, <var>parameters</var> is a comma-separated list of
4066numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4067
4068<pre>
4069Polynomial
4070Sinusoid
4071Arcsin
4072Arctan
4073</pre>
4074
4075<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4076use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4077
4078<dl class="dl-horizontal">
4079 <dt>Polynomial</dt>
4080 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4081these being the coefficients of a polynomial, in decreasing order of degree.
4082That is, entering</p>
4083
4084<pre>
4085-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>
4086</pre>
4087
4088<p>will invoke a polynomial function given by</p>
4089
4090<pre>
4091<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>,
4092</pre>
4093
4094<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4095
4096<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4097(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4098<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004099polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4100href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004101correspondences follow.</p>
4102
4103<table class="table table-condensed table-striped">
4104 <tr>
4105 <td>-evaluate Set <var>value</var> </td>
4106 <td>-function Polynomial <var>value</var></td>
4107 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4108 </tr>
4109 <tr>
4110 <td>-evaluate Add <var>value</var> </td>
4111 <td>-function Polynomial 1,<var>value</var></td>
4112 </tr>
4113 <tr>
4114 <td>-evaluate Subtract <var>value</var> </td>
4115 <td>-function Polynomial 1,−<var>value</var></td>
4116 </tr>
4117 <tr>
4118 <td>-evaluate Multiply <var>value</var> </td>
4119 <td>-function Polynomial <var>value</var>,0</td>
4120 </tr>
4121 <tr>
4122 <td>+level black% x white%</td>
4123 <td>-function Polynomial A,B</td>
4124 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4125 </tr>
4126</table>
4127
4128<p>The <code>Polynomial</code> function gives great versatility, since
4129polynomials can be used to fit any continuous curve to any degree of accuracy
4130desired.</p>
4131
4132</dd>
4133<dt>Sinusoid</dt>
4134<dd>
4135<p>The <code>Sinusoid</code> function can be used to vary the channel values
4136sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4137values are given as one to four parameters, as follows,</p>
4138
4139<pre>
4140-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4141</pre>
4142
4143<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4144corresponds to 0 through <var>freq</var>×360 degrees.)
4145The result is that if a pixel's normalized channel value is originally
4146<b><var>u</var></b>, its resulting normalized value is given by </p>
4147
4148<pre>
4149<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4150</pre>
4151
4152<p> For example, the following generates a curve that starts and ends at 0.9
4153(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4154.7−.2=.5 and .7+.2=.9. </p>
4155
4156<pre>
4157-function Sinusoid 3,-90,.2,.7
4158</pre>
4159
4160<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4161is 0.</p>
4162
4163<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4164<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4165varying amplitude, phase and bias. The correspondence is as follows.</p>
4166
4167<table class="table table-condensed table-striped">
4168 <tr>
4169 <td>-evaluate Sin <var>freq</var> </td>
4170 <td>-function Sinusoid <var>freq</var>,0 </td>
4171 </tr>
4172 <tr>
4173 <td>-evaluate Cos <var>freq</var> </td>
4174 <td>-function Sinusoid <var>freq</var>,90 </td>
4175 </tr>
4176</table>
4177 </dd>
4178<dt>ArcSin</dt>
4179<dd>
4180<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4181and can be used to generate cylindrical distortion and displacement maps.
4182The curve can be adjusted relative to both the input values and output range
4183of values.</p>
4184
4185<pre>
4186-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4187</pre>
4188
4189<p>with all values given in terms of normalized color values (0.0 for black,
41901.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4191for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4192
4193<pre>
4194<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4195</pre>
4196
4197</dd>
4198<dt>ArcTan</dt>
4199<dd>
4200<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4201limit values at infinities, though a center using the given slope value.
4202All these values can be adjusted via the arguments.</p>
4203
4204<pre>
4205-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4206</pre>
4207
4208<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4209</p>
4210
4211<pre>
4212<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4213</pre>
4214 </dd>
Cristy594d2772015-11-15 10:47:42 -05004215 </tr>
Cristy882d9f42015-10-29 16:48:39 -04004216</dl>
4217
4218
4219
4220<div style="margin: auto;">
4221 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4222</div>
4223
4224<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4225
4226<p>A number of algorithms search for a target color. By default the color must
4227be exact. Use this option to match colors that are close to the target color
4228in RGB space. For example, if you want to automagically trim the edges of an
4229image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4230background color may differ by a small amount. This option can account for
4231these differences.</p>
4232
4233<p>The <var>distance</var> can be in absolute intensity units or, by
4234appending <code>%</code> as a percentage of the maximum possible intensity (255,
423565535, or 4294967295).</p>
4236
Cristy594d2772015-11-15 10:47:42 -05004237<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 -04004238
4239
4240<div style="margin: auto;">
4241 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4242</div>
4243
4244<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4245
4246<p>If the first character of <var>expression</var> is <code>@</code>,
4247the expression is read from a file titled by the remaining characters in the
4248string.</p>
4249
4250<p>See <a href="fx.html">FX,
4251The Special Effects Image Operator</a> for a detailed discussion of this
4252option.</p>
4253
4254
4255<div style="margin: auto;">
4256 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4257</div>
4258
4259<p class="magick-description">level of gamma correction.</p>
4260
4261<p>The same color image displayed on two different workstations may look
4262different due to differences in the display monitor. Use gamma correction to
4263adjust for this color difference. Reasonable values extend from
4264<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4265gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4266result in the loss of some image information if the pixel quantum size is only
4267eight bits (quantum range 0 to 255).</p>
4268
4269<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4270a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4271normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4272same as taking the square root of the image.</p>
4273
4274<p>You can apply separate gamma values to the red, green, and blue channels of
4275the image with a gamma value list delimited with commas (e.g.,
4276<code>1.7,2.3,1.2</code>).</p>
4277
4278<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4279image gamma level without actually adjusting the image pixels. This option
4280is useful if the image is of a known gamma but not set as an image attribute
4281(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4282display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4283chunk, use</p>
4284
4285<pre>
4286convert input.png +gamma .45455 output.png
4287</pre>
4288
4289<p>(0.45455 is 1/2.2)</p>
4290
4291<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4292
4293<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004294 <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 -04004295</div>
4296
4297<p class="magick-description">Blur the image with a Gaussian operator.</p>
4298
4299<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004300<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004301
Cristy594d2772015-11-15 10:47:42 -05004302<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 -04004303
Cristy594d2772015-11-15 10:47:42 -05004304<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004305determines the actual amount of blurring that will take place. </p>
4306
Cristy594d2772015-11-15 10:47:42 -05004307<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004308array which will hold the calculated Gaussian distribution. It should be an
4309integer. If not given, or set to zero, IM will calculate the largest possible
4310radius that will provide meaningful results for the Gaussian distribution.
4311</p>
4312
Cristy594d2772015-11-15 10:47:42 -05004313<p>The larger the <var >Radius</var> the radius the slower the
4314operation is. However too small a <var >Radius</var>, and sever
4315aliasing effects may result. As a guideline, <var >Radius</var>
4316should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004317times will produce a more accurate result. </p>
4318
4319<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4320full 2-dimensional convolution is used to generate the weighted average of the
4321neighboring pixels. </p>
4322
4323<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4324pixels which are outside the image proper are blurred into the final result.
4325</p>
4326
4327
4328<div style="margin: auto;">
4329 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4330</div>
4331
4332<p class="magick-description">Set the preferred size and location of the image.</p>
4333
4334<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4335
4336<div style="margin: auto;">
4337 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4338</div>
4339
4340<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4341
4342<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4343<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004344<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4345href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4346href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004347installation.</p>
4348
4349<p>The direction you choose specifies where to position text or subimages. For
4350example, a gravity of <code>Center</code> forces the text to be centered within
Cristy594d2772015-11-15 10:47:42 -05004351the image. By default, the image gravity is <code>NorthWest</code>. See <a
4352href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4353text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4354href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004355
4356<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4357<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004358take <var>geometry</var> as an argument, such as the <a
4359href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004360
4361<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4362or setting having a <var>geometry</var> argument that specifies an
4363offset, the offset is usually applied to the point within the image suggested
4364by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4365command, for example, suppose the file <code>image.png</code> has dimensions
4366200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4367is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4368<code>Center</code>, which suggests the midpoint of the image, at the point
4369(100,50). The offset (−40,20) is applied to that point, giving
4370(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4371that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4372region itself, which is <var>centered</var> at the pixel
4373coordinate (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>
4374
4375<pre>
4376convert image.png -gravity Center -region 10x10-40+20 \
4377 -negate output.png
4378</pre>
4379
Cristy594d2772015-11-15 10:47:42 -05004380<p>When used as an option to <a href="composite.html">composite</a>, <a
4381href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004382within the composite.</p>
4383
Cristy594d2772015-11-15 10:47:42 -05004384<p>When used as an option to <a href="montage.html">montage</a>, <a
4385href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004386within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4387
4388
4389<div style="margin: auto;">
4390 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4391</div>
4392
4393<p class="magick-description">convert image to grayscale.</p>
4394
Cristy594d2772015-11-15 10:47:42 -05004395<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004396convert the given image into a linear-grayscale image. </p>
4397
4398<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4399
4400<pre>
4401convert in.png -grayscale Rec709Luminance out.png
4402</pre>
4403
4404<p>which is equivalent to:</p>
4405
4406<pre>
4407convert in.png -colorspace gray out.png
4408</pre>
4409
4410<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4411
4412<pre>
4413convert in.png -grayscale Rec709Luma out.png
4414</pre>
4415
4416<p>which is equivalent to:</p>
4417
4418<pre>
4419convert in.png -set colorspace RGB -colorspace gray out.png
4420</pre>
4421
4422<p>Note that a 'colorspace' intensity method will produce the same result
4423regardless of the current colorpsace of the image. But a 'mathematical'
4424intensity method will depend on the current colorspace the image is currently
4425using. </p>
4426
Cristy594d2772015-11-15 10:47:42 -05004427<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4428it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004429will not effect other operations that may use that setting.</p>
4430
4431
4432<div style="margin: auto;">
4433 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4434</div>
4435
4436<p class="magick-description">green chromaticity primary point.</p>
4437
4438
4439<div style="margin: auto;">
4440 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4441</div>
4442
4443<p class="magick-description">apply a Hald color lookup table to the image.</p>
4444
4445<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4446dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4447can apply any color transformation to the Hald image and then use this option
4448to apply the transform to the image. </p>
4449
4450<pre>
4451convert image.png hald.png -hald-clut transform.png
4452</pre>
4453
4454<p>This option provides a convenient method for you to use Gimp or Photoshop
4455to make color corrections to the Hald CLUT image and subsequently apply them
4456to multiple images using an ImageMagick script. </p>
4457
4458<p>Note that the representation is only of the normal RGB color space and that
4459the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004460represented Hald color cube image. Because of this the operation is not <a
4461href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004462images transparency or alpha/matte channel.</p>
4463
Cristy594d2772015-11-15 10:47:42 -05004464<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy882d9f42015-10-29 16:48:39 -04004465of the individual color channels, usually involving a simpler gray-scale
4466image. E.g: gray-scale to color replacement, or modification by a histogram
4467mapping. </p>
4468
4469
4470<div style="margin: auto;">
4471 <h3 class="magick-header"><a id="help"></a>-help</h3>
4472</div>
4473
4474<p class="magick-description">print usage instructions.</p>
4475
4476<div style="margin: auto;">
4477 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4478</div>
4479
4480<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4481
4482<div style="margin: auto;">
4483 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4484</div>
4485
4486<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4487
4488<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4489
4490<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>.
4491
4492<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>
4493
Cristy594d2772015-11-15 10:47:42 -05004494<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 -04004495
Cristy594d2772015-11-15 10:47:42 -05004496<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 -04004497
Cristy594d2772015-11-15 10:47:42 -05004498<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 -04004499
4500<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4501
Cristy594d2772015-11-15 10:47:42 -05004502<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 -04004503
4504<div style="margin: auto;">
4505 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4506</div>
4507
4508<p class="magick-description">specify the icon geometry.</p>
4509
4510<p>Offsets, if present in the geometry specification, are handled in the same
4511manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4512handle negative offsets.</p>
4513
4514<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4515
4516<div style="margin: auto;">
4517 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4518</div>
4519
4520<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4521
4522<div style="margin: auto;">
4523 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4524</div>
4525
4526<p class="magick-description">identify the format and characteristics of the image.</p>
4527
4528<p>This information is printed: image scene number; image name; image size;
4529the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4530number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4531a description of the image class.</p>
4532
4533<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004534in the image and color reduction error values are printed. Refer to <a
4535href="quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004536reduction algorithm</a> for a description of these values.</p>
4537
4538<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4539amounts of image properties are displayed including image statistics, profiles,
4540image histogram, and others.</p>
4541
4542<div style="margin: auto;">
4543 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4544</div>
4545
4546<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4547
4548<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4549users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4550images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004551domain. See for example, <a
4552href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004553<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4554<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4555
4556<p>For example, depending upon the image format used to store the result of
4557the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4558
4559<pre>
4560convert fft_image.miff -ift fft_image_ift.png
4561</pre>
4562
4563<p>or</p>
4564
4565<pre>
4566convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4567</pre>
4568
4569<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004570the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4571href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004572the right and/or bottom sides of the image.</p>
4573
4574<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4575use <a href="command-line-options.html#ift">-ift</a>.</p>
4576
4577<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4578and imaginary images from the frequency domain to a single image in the normal
4579(spatial) domain.</p>
4580
Cristy594d2772015-11-15 10:47:42 -05004581<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 -04004582
4583<div style="margin: auto;">
4584 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4585</div>
4586
4587<p class="magick-description">make image immutable.</p>
4588
4589<div style="margin: auto;">
4590 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4591</div>
4592
4593<p class="magick-description">implode image pixels about the center.</p>
4594
4595<div style="margin: auto;">
4596 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4597</div>
4598
4599<p class="magick-description">insert the last image into the image sequence.</p>
4600
4601<p>This option takes last image in the current image sequence and inserts it
4602at the given index. If a negative index is used, the insert position is
4603calculated before the last image is removed from the sequence. As such
4604<code>-insert -1</code> will result in no change to the image sequence.</p>
4605
4606<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4607other words, insert the last image, at the end of the current image sequence.
4608Consequently this has no effect on the image sequence order.</p>
4609
4610<div style="margin: auto;">
4611 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4612</div>
4613
4614<p class="magick-description">method to generate intensity value from pixel.</p>
4615
4616<p>ImageMagick provides a number of methods used in situations where an
4617operator needs to determine a single grayscale value for some purpose, from
4618an image with red, green, and blue pixel components. Typically the linear
4619<code>Rec709Luminance</code> formula is used, which is the same formula used when
4620converting images to <code>-colorspace gray</code>. </p>
4621
4622<p>The following formulas are currently provided, and will first convert
4623the pixel values to linear-RGB or non-linear sRGB colorspace before
4624being applied to calculate the final greyscale value. </p>
4625
4626<dl class="dl-horizontal">
4627<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4628<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4629<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4630<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4631<dt>Brightness</dt><dd> max(R', G', B')</dd>
4632<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4633</dl>
4634
4635<p>Note that the above R,G,B values is the image's linear-RGB values, while
4636R',G',B' are sRGB non-linear values. </p>
4637
4638<p>These intensity methods are mathematical in nature and will use the
4639current value in the images respective R,G,B channel regardless of
4640what that is, or what colorspace the image is currently using.</p>
4641
4642<dl class="dl-horizontal">
4643<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4644<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4645<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4646</dl>
4647
4648<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004649grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4650>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004651
4652<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4653error comparisions. While... The method 'RMS' (Root Mean Squared) for
4654example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004655difference image. This is equivalent to the color only component of the <a
4656href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004657
Cristy594d2772015-11-15 10:47:42 -05004658<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4659grayscaling formula directly to an image without setting the <a
4660href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004661
Cristy594d2772015-11-15 10:47:42 -05004662<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004663the current intensity setting, but will always convert the image to the
4664appropriate sRGB or linear-RGB colorspace before appling the above
4665function.</p>
4666
4667<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4668
Cristy594d2772015-11-15 10:47:42 -05004669<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004670
4671<pre>
4672-adaptive-blur
4673-adaptive-sharpen
4674-black-threshold
4675-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4676-colors for gray colorspace
4677-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4678-contrast-stretch
4679-distort {ErodeIntensity, DilateIntensity}
4680-normalize
4681-random-threshold
4682-selective-blur
4683-shade
4684-threshold
4685-tint
4686-white-threshold
4687</pre>
4688
4689<div style="margin: auto;">
4690 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4691</div>
4692
4693<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4694
4695<p>Use this option to affect the color management operation of an image (see
4696<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4697Perceptual, Relative, Saturation</code>.</p>
4698
4699<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4700
4701<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4702
4703<div style="margin: auto;">
4704 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4705</div>
4706
4707<p class="magick-description">the type of interlacing scheme.</p>
4708
4709<p>Choose from:</p>
4710
4711<pre>
4712none
4713line
4714plane
4715partition
4716JPEG
4717GIF
4718PNG
4719</pre>
4720
4721<p>This option is used to specify the type of interlacing scheme for raw image
4722formats such as <code>RGB</code> or <code>YUV</code>.</p>
4723
4724<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4725
4726<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4727
4728<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4729
4730<p><code>Partition</code> is like plane except the different planes are saved to
4731individual files (e.g. image.R, image.G, and image.B).</p>
4732
4733<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4734PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4735
4736<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4737interlace</a>.</p>
4738
4739<div style="margin: auto;">
4740 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4741</div>
4742
4743<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>
4744
4745<p>When looking up the color of a pixel using a non-integer floating point
4746value, you typically fall in between the pixel colors defined by the source
4747image. This setting determines how the color is determined from the colors of
4748the pixels surrounding that point. That is how to determine the color of a
4749point that falls between two, or even four different colored pixels. </p>
4750
4751<dl class="dl-horizontal">
4752 <dt>integer</dt>
4753 <dd>The color of the top-left pixel (floor function)</dd>
4754 <dt>nearest-neighbor</dt>
4755 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4756 <dt>average</dt>
4757 <dd>The average color of the surrounding four pixels</dd>
4758 <dt>bilinear</dt>
4759 <dd>A double linear interpolation of pixels (the default)</dd>
4760 <dt>mesh</dt>
4761 <dd>Divide area into two flat triangular interpolations</dd>
4762 <dt>bicubic</dt>
4763 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4764 <dt>spline</dt>
4765 <dd>Direct spline curves (colors are blurred)</dd>
4766 <dt>filter</dt>
4767 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4768</dl>
4769
Cristy594d2772015-11-15 10:47:42 -05004770<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4771>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4772>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004773
4774<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4775
Cristy594d2772015-11-15 10:47:42 -05004776<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004777lookup for positions outside the boundaries of the image. </p>
4778
4779
4780<div style="margin: auto;">
4781 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4782</div>
4783
4784<p class="magick-description">the space between two text lines.</p>
4785
4786<div style="margin: auto;">
4787 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4788</div>
4789
4790<p class="magick-description">the space between two words.</p>
4791
4792<div style="margin: auto;">
4793 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4794</div>
4795
4796<p class="magick-description">the space between two letters.</p>
4797
4798<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004799 <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 -04004800</div>
4801
4802<p class="magick-description">edge preserving noise reduction filter.</p>
4803
Cristy594d2772015-11-15 10:47:42 -05004804<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 -04004805
4806
4807<div style="margin: auto;">
4808 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4809</div>
4810
4811<p class="magick-description">assign a label to an image.</p>
4812
4813<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004814or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004815a the labels of images already read in. Image formats such as TIFF, PNG,
4816MIFF, supports saving the label information with the image.</p>
4817
4818<p>When saving an image to a <var>PostScript</var> file, any label
4819assigned to an image is used as a header string to print above the postscript
4820image. </p>
4821
4822<p>You can include the image filename, type, width, height, or other image
4823attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4824Properties</a> for details of the percent escape codes.</p>
4825
4826<p>For example,</p>
4827
4828<pre>
4829-label "%m:%f %wx%h" bird.miff
4830</pre>
4831
4832<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4833"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4834is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4835existing label present in the image would be used. You can remove all labels
4836from an image by assigning the empty string. </p>
4837
4838<p>A label is not drawn on the image, but is embedded in the image datastream
4839via <var>Label</var> tag or similar mechanism. If you want the label to be
4840visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4841during the final processing in the creation of an image montage.</p>
4842
4843<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4844remaining characters in the string. Labels in a file are literal, no embedded
4845formatting characters are recognized.</p>
4846
4847
4848<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004849 <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 -04004850</div>
4851
4852<p class="magick-description">perform local adaptive threshold.</p>
4853
4854<p>Adaptively threshold each pixel based on the value of pixels in a
4855surrounding window. If the current pixel is lighter than this average plus
4856the optional <code>offset</code>, then it is made white, otherwise it is made
4857black. Small variations in pixel values such as found in scanned documents
4858can be ignored if offset is positive. A negative offset will make it more
4859sensitive to those small variations. </p>
4860
4861<p>This is commonly used to threshold images with an uneven background. It is
4862based on the assumption that average color of the small window is the
4863the local background color, from which to separate the foreground color. </p>
4864
4865
4866<div style="margin: auto;">
4867 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
4868</div>
4869
4870<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
4871
4872<p>Perform various image operation methods to a ordered sequence of images
4873which may represent either a set of overlaid 'image layers', a GIF disposal
4874animation, or a fully-'coalesced' animation sequence. </p>
4875
4876<table class="table table-condensed table-striped">
4877 <tbody>
4878 <tr>
4879 <th style="width: 8%">Method</th>
4880 <th>Description</th>
4881 </tr>
4882
4883 <tr>
4884 <td>compare-any</td>
4885 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05004886 that contains all the differences between the two images. No GIF <a
4887 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04004888 </tr>
4889
Cristy594d2772015-11-15 10:47:42 -05004890 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
4891 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04004892 working, especially when animation used layer disposal methods such as
4893 '<code>Previous</code>' or '<code>Background</code>'. </td>
4894 </tr>
4895
4896 <tr>
4897 <td>compare-clear</td>
4898 <td>As '<code>compare-any</code>' but crop to the bounds of any
4899 opaque pixels which become transparent in the second frame. That is the
4900 smallest image needed to mask or erase pixels for the next frame. </td>
4901 </tr>
4902
4903 <tr>
4904 <td>compare-overlay</td>
4905 <td>As '<code>compare-any</code>' but crop to pixels that add
4906 extra color to the next image, as a result of overlaying color pixels.
4907 That is the smallest single overlaid image to add or change colors. </td>
4908 </tr>
4909
Cristy594d2772015-11-15 10:47:42 -05004910 <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 -04004911 composition method '<code>change-mask</code>', to reduce the image to
4912 just the pixels that need to be overlaid. </td>
4913 </tr>
4914
4915 <tr>
4916 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05004917 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
4918 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04004919 current image sequence to form a fully defined animation sequence, as
4920 it should be displayed. Effectively converting a GIF animation into a
4921 'film strip'-like animation. </td>
4922 </tr>
4923
4924 <tr>
4925 <td>composite</td>
4926 <td>Alpha Composition of two image lists, separated by a
4927 "<code>null:</code>" image, with the destination image list first, and
4928 the source images last. An image from each list are composited
4929 together until one list is finished. The separator image and source
4930 image lists are removed. </td>
4931 </tr>
4932
4933
4934 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05004935 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
4936 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
4937 canvas size of the first image in each list. Unlike a normal <a
4938 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04004939 added to the final composite positioning of each image. </td> </tr>
4940
4941 <tr><td></td>
4942 <td>If one of the image lists only contains one image, that image is
4943 applied to all the images in the other image list, regardless of which
4944 list it is. In this case it is the image meta-data of the list which
4945 preserved. </td>
4946 </tr>
4947
4948
4949 <tr>
4950 <td>dispose</td>
4951 <td>This like '<code>coalesce</code>' but shows the look of
4952 the animation after the layer disposal method has been applied, before
4953 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05004954 results from the application of the GIF <a href="command-line-options.html#dispose"
4955 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04004956 is going wrong with a particular animation you may be developing.
4957 </td>
4958 </tr>
4959
4960 <tr>
4961 <td>flatten</td>
4962 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05004963 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
4964 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04004965 canvas. Images falling outside that canvas is clipped. Final
4966 image will have a zero virtual canvas offset. </td>
4967 </tr>
4968
4969 <tr><td></td>
4970 <td>This usually used as one of the final 'image layering' operations
4971 overlaying all the prepared image layers into a final image. </td>
4972 </tr>
4973
4974 <tr><td></td>
4975 <td>For a single image this method can also be used to fillout a virtual
4976 canvas with real pixels, or to underlay an opaque color to remove
4977 transparency from an image.</td>
4978 </tr>
4979
4980
4981 <tr>
4982 <td>merge</td>
4983 <td>As 'flatten' method but merging all the given image
4984 layers to create a new layer image just large enough to hold all the
4985 image without clipping or extra space. The new images virtual offset
4986 will preserve the position of the new layer, even if this offset is
4987 negative. The virtual canvas size of the first image is preserved.
4988 </td>
4989 </tr>
4990
4991 <tr><td></td><td>Caution is advised when handling image layers with
4992 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05004993 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04004994 will remove the layer offset, and create an image in which all the
4995 overlaid image positions relative to each other is preserved, though
4996 not necessarily exactly where you specified them.
4997 </td>
4998 </tr>
4999
5000 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5001 without doing the'flatten' to merge the images together. </td>
5002 </tr>
5003
5004 <tr>
5005 <td>mosaic</td>
5006 <td>As 'flatten' method but expanding the initial canvas size
5007 of the first image in a positive direction only so as to hold all the
5008 image layers. However as a virtual canvas is 'locked' to the origin,
5009 by its own definition, image layers with a negative offsets will still
5010 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5011 if this could be a problem. </td>
5012
5013 </tr>
5014
5015 <tr><td></td><td>This method is commonly used to layout individual image
5016 using various offset but without knowing the final canvas size. The
5017 resulting image will, like 'flatten' not have any virtual offset, so
5018 can be saved to any image file format. </td>
5019 </tr>
5020
5021
5022 <tr>
5023 <td>optimize</td>
5024 <td>Optimize a coalesced animation, into GIF animation using
5025 a number of general techniques. This currently a short cut to
5026 apply both the '<code>optimize-frame</code>', and
5027 '<code>optimize-transparency</code>' methods but may be expanded to
5028 include other optimization methods as they are developed. </td>
5029 </tr>
5030
5031 <tr>
5032 <td>optimize-frame</td>
5033 <td>Optimize a coalesced animation, into GIF animation by
5034 reducing the number of pixels per frame as much as possible by
5035 attempting to pick the best layer disposal method to use, while ensuring
5036 the result will continue to animate properly. </td>
5037 </tr>
5038
5039 <tr><td></td><td> There is no guarantee that the best optimization is found.
5040 But then no reasonably fast GIF optimization algorithm can do this.
5041 However this does seem to do better than most other GIF frame
5042 optimizers seen. </td>
5043 </tr>
5044
5045 <tr>
5046 <td>optimize-plus</td>
5047 <td>As '<code>optimize-frame</code>' but attempt to improve the
5048 overall optimization by adding extra frames to the animation, without
5049 changing the final look or timing of the animation. The frames are
5050 added to attempt to separate the clearing of pixels from the
5051 overlaying of new additional pixels from one animation frame to the
5052 next. If this does not improve the optimization (for the next frame
5053 only), it will fall back to the results of the previous normal
5054 '<code>optimize-frame</code>' technique. </td>
5055 </tr>
5056
5057 <tr><td></td><td>There is the possibility that the change in the disposal
5058 style will result in a worsening in the optimization of later frames,
5059 though this is unlikely. In other words there no guarantee that it is
5060 better than the normal '<code>optimize-frame</code>' technique. For some
5061 animations however you can get a vast improvement in the final
5062 animation size. </td>
5063 </tr>
5064
5065 <tr>
5066 <td>optimize-transparency</td>
5067 <td>Given a GIF animation, replace any pixel in the sub-frame
5068 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005069 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005070 </td>
5071 </tr>
5072
5073 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5074 to compress into a smaller file size due to larger areas of one
5075 (transparent) color rather than a pattern of multiple colors repeating
5076 the current disposed image of the last frame. </td>
5077 </tr>
5078
5079 <tr>
5080 <td>remove-dups</td>
5081 <td>Remove (and merge time delays) of duplicate consecutive
5082 images, so as to simplify layer overlays of coalesced animations.
5083 </td>
5084 </tr>
5085
5086 <tr><td></td><td>Usually this a result of using a constant time delay
5087 across the whole animation, or after a larger animation was split into
5088 smaller sub-animations. The duplicate frames could also have been
5089 used as part of some frame optimization methods. </td>
5090 </tr>
5091
5092 <tr>
5093 <td>remove-zero</td>
5094 <td>Remove any image with a zero time delay, unless ALL the
5095 images have a zero time delay (and is not a proper timed animation, a
5096 warning is then issued). </td>
5097 </tr>
5098
5099 <tr><td></td><td>In a GIF animation, such images are usually frames which
5100 provide partial intermediary updates between the frames that are
5101 actually displayed to users. These frames are usually added for
5102 improved frame optimization in GIF animations. </td>
5103 </tr>
5104
5105 <tr>
5106 <td>trim-bounds</td>
5107 <td>Find the bounds of all the images in the current
5108 image sequence, then adjust the offsets so all images are contained on
5109 a minimal positive canvas. None of the image data is modified or
5110 merged, only the individual image virtual canvas size and offset.
5111 All the images is given the same canvas size, and and will have
5112 a positive offset, but will remain in the same position relative to
5113 each other. As a result of the minimal canvas size at least one image
5114 will touch every edge of that canvas. The image data touching those
5115 edges however may be transparent. </td>
5116 </tr>
5117
5118 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005119 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005120 have been kept separate. If 'flatten' is used after using
5121 'trim-bounds' you will get the same result. </td>
5122 </tr>
5123
5124 </tbody>
5125</table>
5126
5127<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5128
Cristy594d2772015-11-15 10:47:42 -05005129<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5130>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5131>-mosaic</a> are only aliases for the above methods and may be depreciated in
5132the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5133>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5134GIF <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 -04005135settings. </p>
5136
5137
5138<div style="margin: auto;">
5139 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5140</div>
5141
5142<p class="magick-description">adjust the level of image channels.</p>
5143
5144<p>Given one, two or three values delimited with commas: black-point,
5145white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5146white points range from 0 to <var>QuantumRange</var>, or from 0 to
5147100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5148If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005149points are percentages of the full color range. Gamma will do a <a
5150href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005151default of 1.0 (no gamma correction) is assumed.</p>
5152
5153<p>In normal usage (<code>-level</code>) the image values are stretched so that
5154the given '<code>black_point</code>' value in the original image is set to zero
5155(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5156contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5157image will then be adjusted. </p>
5158
5159<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5160(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5161list, will cause the operator to do the reverse of the level adjustment. That
5162is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5163in the original image, is adjusted to the given level values, allowing you to
5164de-contrast, or compress the channel values within the image. The
5165'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5166image is made. </p>
5167
5168<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5169setting are adjusted (defaults to RGB color channels only), allowing you to
5170limit the effect of this operator. </p>
5171
5172<p>Please note that the transparency channel is treated as 'matte'
5173values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5174
5175
5176<div style="margin: auto;">
5177 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5178</div>
5179
5180<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5181
5182<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5183value value for each color channel is determined by the
5184'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5185described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5186
5187<p>This effectually means the colors provided to <code>-level-colors</code>
5188is mapped to become 'black' and 'white' respectively, with all the other
5189colors linearly adjusted (or clipped) to match that change. Each channel is
5190adjusted separately using the channel values of the colors specified. </p>
5191
5192<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5193will map the image color 'black' and 'white' to the given colors
5194respectively, resulting in a gradient (de-contrasting) tint of the image to
5195those colors. This can also be used to convert a plain gray-scale image into a
5196one using the gradient of colors specified. </p>
5197
5198<p>By supplying a single color with a comma separator either before or after
5199that color, will just replace the respective 'black' or 'white' point
5200respectively. But if no comma separator is provided, the given color is
5201used for both the black and white color points, making the operator either
5202threshold the images around that color (- form) or set all colors to that
5203color (+ form). </p>
5204
5205
5206<div style="margin: auto;">
5207 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5208</div>
5209
5210<p class="magick-description">Set the pixel cache resource limit.</p>
5211
5212<p>Choose from: <code>area</code>, <code>disk</code>, <code>file</code>,
5213<code>map</code>, <code>memory</code>, <code>thread</code>, or <code>time</code>.</p>
5214
5215<p>The value for <code>file</code> is in number of files. The other limits are
5216in bytes. Define arguments for the memory, map, area, and disk resource limits
5217with SI prefixes (.e.g 100MB).</p>
5218
5219<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5220memory map, and 18.45EB of disk. These limits are adjusted relative to the
5221available resources on your computer if this information is available. When
5222any limit is reached, ImageMagick fails in some fashion but attempts to take
5223compensating actions, if possible. For example, the following limits
5224memory:</p>
5225
5226<pre>
5227-limit memory 32MiB -limit map 64MiB
5228</pre>
5229
5230<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>
5231
5232<pre>
Cristy594d2772015-11-15 10:47:42 -05005233-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005234Resource limits:
5235 Width: 100MP
5236 Height: 100MP
5237 Area: 25.181GB
5238 Memory: 11.726GiB
5239 Map: 23.452GiB
5240 Disk: unlimited
5241 File: 768
5242 Thread: 12
5243 Throttle: 0
5244 Time: unlimited
5245</pre>
5246
5247<p>Requests for pixel storage to keep intermediate images are satisfied by one
5248of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005249disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005250and whether the system honors a resource request. If the total size of
5251allocated pixel storage in the given pool reaches the corresponding limit, the
5252request is passed to the next pool. Additionally, requests that exceed the
5253<code>area</code> limit automagically are allocated on disk.</p>
5254
5255<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5256image resource request. First, ImageMagick tries to allocate the pixels in
5257memory. The request might be denied if the resource request exceeds the
5258<code>memory</code> limit or if the system does not honor the request. If
5259a memory request is not honored, the pixels are allocated to disk and the file
5260is memory-mapped. However, if the allocation request exceeds the
5261<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5262the resource request exceeds the <code>area</code> limit, the pixels are
5263automagically cached to disk. If the disk has a hard limit, the program
5264fails.</p>
5265
5266<p>In most cases you simply do not need to concern yourself with resource
5267limits. ImageMagick chooses reasonable defaults and most images do not tax
5268your computer resources. Where limits do come in handy is when you process
5269images that are large or on shared systems where ImageMagick can consume all
5270or most of the available memory. In this case, the ImageMagick workflow slows
5271other processes or, in extreme cases, brings the system to a halt. Under
5272these circumstances, setting limits give some assurances that the ImageMagick
5273workflow will not interfere with other concurrent uses of the computer. For
5274example, assume you have a web interface that processes images uploaded from
5275the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5276simply set the area limit to 10MiB:</p>
5277
5278<pre>
5279-limit area 10MB
5280</pre>
5281
5282<p>Now whenever a large image is processed, the pixels are automagically
5283cached to disk instead of memory. This of course implies that large images
5284typically process very slowly, simply because pixel processing in memory can
5285be an order of magnitude faster than on disk. Because your web site users
5286might inadvertently upload a huge image to process, you should set a disk
5287limit as well:</p>
5288
5289<pre>
5290-limit area 10MB -limit disk 500MB
5291</pre>
5292
5293<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5294
5295<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005296with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005297environment variables <code>MAGICK_AREA_LIMIT</code>,
5298<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5299<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5300<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5301image area, disk space, open files, heap memory, memory map, number of threads
5302of execution, and maximum elapsed time in seconds respectively.</p>
5303
5304<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5305their commands and then scouring the generated output for references to the
5306pixel cache, in order to determine how the pixel cache was allocated and how
5307resources were consumed. Advanced Unix/Linux users can pipe that output
5308through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5309</p>
5310
5311<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005312Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5313">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005314
5315<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005316 <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 -04005317</div>
5318
5319<p class="magick-description">Linear with saturation stretch.</p>
5320
Cristy594d2772015-11-15 10:47:42 -05005321<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005322and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005323be stretched. However it then stretches those colors using the <a
5324href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005325
5326<p>As such while the initial determination may have 'binning' round off
5327effects, the image colors are stretched mathematically, rather than using the
5328histogram bins. This makes the operator more accurate. </p>
5329
Cristy594d2772015-11-15 10:47:42 -05005330<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005331'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5332perfect stretch of the color range. </p>
5333
Cristy594d2772015-11-15 10:47:42 -05005334<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005335normalization of mathematical images. </p>
5336
5337<p>This operator is under review for re-development. </p>
5338
5339
5340<div style="margin: auto;">
5341 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5342</div>
5343
5344<p class="magick-description">the line width for subsequent draw operations.</p>
5345
5346<div style="margin: auto;">
5347 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5348</div>
5349
5350<p class="magick-description">rescale image with seam-carving.</p>
5351
5352<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5353
5354<div style="margin: auto;">
5355 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5356</div>
5357
5358<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5359
5360<pre class="pre-scrollable">
5361Align
5362Alpha
5363Boolean
5364Cache
5365Channel
5366Class
5367ClipPath
5368Coder
5369Color
5370Colorspace
5371Command
5372Complex
5373Compose
5374Compress
5375Configure
5376DataType
5377Debug
5378Decoration
5379Delegate
5380Direction
5381Dispose
5382Distort
5383Dither
5384Endian
5385Evaluate
5386FillRule
5387Filter
5388Font
5389Format
5390Function
5391Gravity
5392Intensity
5393Intent
5394Interlace
5395Interpolate
5396Kernel
5397Layers
5398LineCap
5399LineJoin
5400List
5401Locale
5402LogEvent
5403Log
5404Magic
5405Method
5406Metric
5407Mime
5408Mode
5409Morphology
5410Module
5411Noise
5412Orientation
5413PixelIntensity
5414Policy
5415PolicyDomain
5416PolicyRights
5417Preview
5418Primitive
5419QuantumFormat
5420Resource
5421SparseColor
5422Statistic
5423Storage
5424Stretch
5425Style
5426Threshold
5427Type
5428Units
5429Validate
5430VirtualPixel
5431</pre>
5432
5433<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5434list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5435available:</p>
5436
5437<pre>
5438identify -list list
5439</pre>
5440
5441<div style="margin: auto;">
5442 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5443</div>
5444
5445<p class="magick-description">Specify format for debug log.</p>
5446
Cristy594d2772015-11-15 10:47:42 -05005447<p>This option specifies the format for the log printed when the <a
5448href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005449
5450<p>You can display the following components by embedding special format
5451characters:</p>
5452
5453<dl class="dl-horizontal">
5454<dt>%d</dt><dd>domain</dd>
5455<dt>%e</dt><dd>event</dd>
5456<dt>%f</dt><dd>function</dd>
5457<dt>%l</dt><dd>line</dd>
5458<dt>%m</dt><dd>module</dd>
5459<dt>%p</dt><dd>process ID</dd>
5460<dt>%r</dt><dd>real CPU time</dd>
5461<dt>%t</dt><dd>wall clock time</dd>
5462<dt>%u</dt><dd>user CPU time</dd>
5463<dt>%%</dt><dd>percent sign</dd>
5464<dt>\n</dt><dd>newline</dd>
5465<dt>\r</dt><dd>carriage return</dd>
5466</dl>
5467
5468<p>For example:</p>
5469
5470<pre>
5471convert -debug coders -log "%u %m:%l %e" in.gif out.png
5472</pre>
5473
5474<p>The default behavior is to print all of the components.</p>
5475
5476<div style="margin: auto;">
5477 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5478</div>
5479
5480<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5481
5482<p>Set iterations to zero to repeat the animation an infinite number of times,
5483otherwise the animation repeats itself up to <var>iterations</var>
5484times.</p>
5485
5486<div style="margin: auto;">
5487 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5488</div>
5489
5490<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5491
5492<div style="margin: auto;">
5493 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5494</div>
5495
5496<p class="magick-description">double the size of the image with pixel art scaling.</p>
5497
5498
5499<div style="margin: auto;">
5500 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5501</div>
5502
5503<p class="magick-description">Display image using this <var>type</var>.</p>
5504
5505<p>Choose from these <var>Standard Colormap</var> types:</p>
5506
5507<pre>
5508best
5509default
5510gray
5511red
5512green
5513blue
5514</pre>
5515
5516<p>The <var>X server</var> must support the <var>Standard
5517Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5518the type and <code>display</code> searches the list of colormap types in
5519<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5520
5521
5522<div style="margin: auto;">
5523 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5524</div>
5525
5526<p class="magick-description">pixel map.</p>
5527
5528<p>Here are the valid components of a map:</p>
5529
5530<dl class="dl-horizontal">
5531<dt>r</dt><dd> red pixel component</dd>
5532<dt>g</dt><dd> green pixel component</dd>
5533<dt>b</dt><dd> blue pixel component</dd>
5534<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5535<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5536<dt>i</dt><dd> grayscale intensity pixel component</dd>
5537<dt>c</dt><dd> cyan pixel component</dd>
5538<dt>m</dt><dd> magenta pixel component</dd>
5539<dt>y</dt><dd> yellow pixel component</dd>
5540<dt>k</dt><dd> black pixel component</dd>
5541<dt>p</dt><dd> pad component (always 0)</dd>
5542</dl>
5543
5544<p>You can specify as many of these components as needed in any order (e.g.
5545bgr). The components can repeat as well (e.g. rgbr).</p>
5546
5547
5548<div style="margin: auto;">
5549 <h3 class="magick-header"><a id="mask"></a>-mask
5550<var>filename</var></h3>
5551</div>
5552
5553<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
5554
5555<p>This the same as using a mask used for composite masking operations, with
5556grayscale values causing blended updates of the image the mask is attached to.
5557</p>
5558
5559<p>Use <a href="command-line-options.html#mask">+mask</a> to remove the mask from images.</p>
5560
5561<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
5562but with strict boolean masking. </p>
5563
5564<div style="margin: auto;">
5565 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5566</div>
5567
5568<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5569
5570<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5571
Cristy594d2772015-11-15 10:47:42 -05005572<p>The default matte color is <code>#BDBDBD</code>, <span
5573style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005574
5575<div style="margin: auto;">
5576 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5577</div>
5578
5579<p class="magick-description">return the maximum intensity of an image sequence.</p>
5580
5581<p>Select the 'maximum' value from all the surrounding pixels. </p>
5582
Cristy594d2772015-11-15 10:47:42 -05005583<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 -04005584name. </p>
5585
5586<div style="margin: auto;">
5587 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5588</div>
5589
5590<p class="magick-description">apply a median filter to the image.</p>
5591
5592<p>Select the 'middle' value from all the surrounding pixels. </p>
5593
Cristy594d2772015-11-15 10:47:42 -05005594<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 -04005595name. </p>
5596
5597<div style="margin: auto;">
5598 <h3 class="magick-header"><a id="mean-shift"></a>-mean-shift <var>width</var>x<var>height</var>{<var>+distance</var>{%}}</h3>
5599</div>
5600
5601<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5602
5603<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>
5604
5605<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>
5606
5607<div style="margin: auto;">
5608 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5609</div>
5610
5611<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5612
5613<p>Choose from:</p>
5614
5615<dl class="dl-horizontal">
5616<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5617<dt>FUZZ</dt><dd> mean color distance</dd>
5618<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5619<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5620<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5621<dt>NCC</dt><dd> normalized cross correlation</dd>
5622<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
5623<dt>PHASH</dt><dd> perceptual hash</dd>
5624<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5625<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5626</dl>
5627
5628<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005629with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005630only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005631size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005632'similar', while '<code>MAE</code>' determines the factor needed
5633for about half the pixels to be similar. </p>
5634
5635<p>The '<code>MEPP</code>' metric returns three different metrics
5636('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5637normalized) from a single comparison run. </p>
5638
5639<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5640metric</a> option.</p>
5641
5642
5643<div style="margin: auto;">
5644 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5645</div>
5646
5647<p class="magick-description">return the minimum intensity of an image sequence.</p>
5648
5649<p>Select the 'minimal' value from all the surrounding pixels. </p>
5650
Cristy594d2772015-11-15 10:47:42 -05005651<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 -04005652name. </p>
5653
5654
5655
5656<div style="margin: auto;">
5657 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5658</div>
5659
5660<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5661
5662<div style="margin: auto;">
5663 <h3 class="magick-header">-mode <var>value</var></h3>
5664</div>
5665
5666<p class="magick-description">Mode of operation.</p>
5667
5668<p>Choose the <var>value</var> from these styles: <code>Frame,
5669Unframe, or Concatenate</code></p>
5670
Cristy594d2772015-11-15 10:47:42 -05005671<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5672for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005673ImageMagick installation.</p>
5674
5675
5676<div style="margin: auto;">
5677 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5678</div>
5679
5680<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5681
5682<p>The arguments are given as a percentages of variation. A value of 100 means
5683no change, and any missing values are taken to mean 100.</p>
5684
5685<p>The <var>brightness</var> is a multiplier of the overall
5686brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5687twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5688before and after. </p>
5689
5690<p>The <var>saturation</var> controls the amount of color in an
5691image. For example, 0 produce a grayscale image, while a large value such as
5692200 produce a very colorful, 'cartoonish' color.</p>
5693
5694<p>The <var>hue</var> argument causes a "rotation" of the colors
5695within the image by the amount specified. For example, 50 results in
5696a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5697A value of either 0 or 200 results in a complete 180 degree rotation of the
5698image. Using a value of 300 is a 360 degree rotation resulting in no change to
5699the original image. </p>
5700
5701<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005702saturation by 10% and leave the hue unchanged, use <a
5703href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005704
Cristy594d2772015-11-15 10:47:42 -05005705<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5706>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005707modulate. 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>
5708
5709<pre>
5710convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5711</pre>
5712
5713<div style="margin: auto;">
5714 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5715</div>
5716
5717<p class="magick-description">report image moments and perceptual hash.</p>
5718
5719
5720<div style="margin: auto;">
5721 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5722</div>
5723
5724<p class="magick-description">monitor progress.</p>
5725
5726
5727<div style="margin: auto;">
5728 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5729</div>
5730
5731<p class="magick-description">transform the image to black and white.</p>
5732
5733<div style="margin: auto;">
5734 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5735</div>
5736
5737<p class="magick-description">morphs an image sequence.</p>
5738
5739<p>Both the image pixels and size are linearly interpolated to give the
5740appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005741in the current image list. The added images are the equivalent of a <a
5742href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005743argument determine how many images to interpolate between each image. </p>
5744
5745
5746<div style="margin: auto;">
5747 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5748 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5749</div>
5750
5751<p class="magick-description">apply a morphology method to the image.</p>
5752
Cristy594d2772015-11-15 10:47:42 -05005753<p>Until I get around to writing an option summary for this, see <a
5754href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005755Morphology</a>. </p>
5756
5757
5758<div style="margin: auto;">
5759 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5760</div>
5761
Cristy594d2772015-11-15 10:47:42 -05005762<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 -04005763
5764
5765<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005766 <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 -04005767</div>
5768
5769<p class="magick-description">simulate motion blur.</p>
5770
5771<p>Blur with the given radius, standard deviation (sigma), and angle. The
5772angle given is the angle toward which the image is blurred. That is the
5773direction people would consider the object is coming from. </p>
5774
5775<p>Note that the blur is not uniform distribution, giving the motion a
5776definite sense of direction of movement. </p>
5777
5778<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5779pixels which are outside the image proper are blurred into the final result.
5780</p>
5781
5782<div style="margin: auto;">
5783 <h3 class="magick-header"><a id="name"></a>-name</h3>
5784</div>
5785
5786<p class="magick-description">name an image.</p>
5787<div style="margin: auto;">
5788 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5789</div>
5790
5791<p class="magick-description">replace each pixel with its complementary color.</p>
5792
5793<p>The red, green, and blue intensities of an image are negated. White becomes
5794black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5795negate the grayscale pixels of the image.</p>
5796
5797<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005798 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005799 +noise <var>type</var></h3>
5800</div>
5801
5802<p class="magick-description">Add or reduce noise in an image.</p>
5803
5804<p>The principal function of noise peak elimination filter is to smooth the
5805objects within an image without losing edge information and without creating
5806undesired structures. The central idea of the algorithm is to replace a pixel
5807with its next neighbor in value within a pixel window, if this pixel has been
5808found to be noise. A pixel is defined as noise if and only if this pixel is
5809a maximum or minimum within the pixel window.</p>
5810
5811<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5812specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005813to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005814which should be used in preference.</p>
5815
5816<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
5817types:</p>
5818
5819<pre>
5820Gaussian
5821Impulse
5822Laplacian
5823Multiplicative
5824Poisson
5825Random
5826Uniform
5827</pre>
5828
Cristy594d2772015-11-15 10:47:42 -05005829<p>The amount of noise added can be controlled by the <code><a
5830href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005831equivalent to 1.0, or a maximum noise addition.</p>
5832
5833<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>
5834
5835<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5836
5837<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5838the use of a controlling value to specify the amount of noise that should be
5839added to an image. </p>
5840
5841
5842<div style="margin: auto;">
5843 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5844</div>
5845
5846<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5847
5848<p>The intensity values are stretched to cover the entire range of possible
5849values. While doing so, black-out at most <var>2%</var> of the pixels and
5850white-out at most <var>1%</var> of the pixels.</p>
5851
Cristy594d2772015-11-15 10:47:42 -05005852<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5853is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5854(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5855>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005856
5857<p>All the channels are normalized in concert by the came amount so as to
Cristy594d2772015-11-15 10:47:42 -05005858preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5859setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04005860setting will normalize the RGB channels independently.</p>
5861
Cristy594d2772015-11-15 10:47:42 -05005862<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5863Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04005864that is better suited to mathematically generated images. </p>
5865
5866<p>This operator is under review for re-development. </p>
5867
5868
5869<div style="margin: auto;">
5870 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
5871</div>
5872
5873<p class="magick-description">change this color to the fill color within the image.</p>
5874
5875<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05005876described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
5877>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04005878given.</p>
5879
5880<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
5881the target color. </p>
5882
5883<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05005884as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04005885transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
5886To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05005887channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
5888the new transparent colors, and does not require you to modify the <a
5889href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04005890
5891
5892<div style="margin: auto;">
5893 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
5894</div>
5895
5896<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
5897given number of <var>levels</var> per color channel.</p>
5898
5899<p>You can choose from these standard threshold maps:</p>
5900
5901<pre class="pre-scrollable">
5902threshold 1x1 Threshold 1x1 (non-dither)
5903checks 2x1 Checkerboard 2x1 (dither)
5904o2x2 2x2 Ordered 2x2 (dispersed)
5905o3x3 3x3 Ordered 3x3 (dispersed)
5906o4x4 4x4 Ordered 4x4 (dispersed)
5907o8x8 8x8 Ordered 8x8 (dispersed)
5908h3x4a 4x1 Halftone 4x4 (angled)
5909h6x6a 6x1 Halftone 6x6 (angled)
5910h8x8a 8x1 Halftone 8x8 (angled)
5911h3x4o Halftone 4x4 (orthogonal)
5912h6x6o Halftone 6x6 (orthogonal)
5913h8x8o Halftone 8x8 (orthogonal)
5914h36x16o Halftone 16x16 (orthogonal)
5915c5x5b c5x5 Circles 5x5 (black)
5916c5x5w Circles 5x5 (white)
5917c6x6b c6x6 Circles 6x6 (black)
5918c6x6w Circles 6x6 (white)
5919c7x7b c7x7 Circles 7x7 (black)
5920c7x7w Circles 7x7 (white)
5921</pre>
5922
5923<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05005924This could be used with <var >level</var> to do the equivalent of <a
5925href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04005926</p>
5927
5928<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
5929pattern. That is a grayscale will become a pattern of solid black, solid
5930white, and mid-tone colors into a checkerboard pattern of black and white.
5931</p>
5932
Cristy594d2772015-11-15 10:47:42 -05005933<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04005934dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05005935<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04005936for more details of configuration files. </p>
5937
5938<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05005939<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04005940
5941<p>Note that at this time the same threshold dithering map is used for all
5942color channels, no attempt is made to offset or rotate the map for different
5943channels is made, to create an offset printing effect. Also as the maps are
5944simple threshold levels, the halftone and circle maps will create incomplete
5945circles along the edges of a colored area. Also all the effects are purely
5946on/off boolean effects, without anti-aliasing to make the circles smooth
5947looking. Large dots can be made to look better with a small amount of blurring
5948after being created. </p>
5949
5950
5951<div style="margin: auto;">
5952 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
5953</div>
5954
5955<p class="magick-description">specify orientation of a digital camera image.</p>
5956
5957<p>Choose from these orientations:</p>
5958
5959<pre>
5960bottom-left right-top
5961bottom-right top-left
5962left-bottom top-right
5963left-top undefined
5964right-bottom
5965</pre>
5966
Cristy594d2772015-11-15 10:47:42 -05005967<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04005968orientation</a> option.</p>
5969
5970
5971<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005972 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
5973 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04005974 +page
5975 </h3>
5976</div>
5977
5978<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
5979
5980<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5981
5982<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 -05005983<var>geometry</var> arguments (e.g. <a
5984href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005985
5986<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.
5987The choices for a PostScript page are:</p>
5988
5989<dl class="dl-horizontal">
5990<dt> 11x17 </dt> <dd> 792 x 1224</dd>
5991<dt> Ledger </dt> <dd> 1224 x 792</dd>
5992<dt> Legal </dt> <dd> 612 x 1008</dd>
5993<dt> Letter </dt> <dd> 612 x 792</dd>
5994<dt> LetterSmall</dt> <dd> 612 x 792</dd>
5995<dt> ArchE </dt> <dd> 2592 x 3456</dd>
5996<dt> ArchD </dt> <dd> 1728 x 2592</dd>
5997<dt> ArchC </dt> <dd> 1296 x 1728</dd>
5998<dt> ArchB </dt> <dd> 864 x 1296</dd>
5999<dt> ArchA </dt> <dd> 648 x 864</dd>
6000<dt> A0 </dt> <dd> 2380 x 3368</dd>
6001<dt> A1 </dt> <dd> 1684 x 2380</dd>
6002<dt> A2 </dt> <dd> 1190 x 1684</dd>
6003<dt> A3 </dt> <dd> 842 x 1190</dd>
6004<dt> A4 </dt> <dd> 595 x 842</dd>
6005<dt> A4Small </dt> <dd> 595 x 842</dd>
6006<dt> A5 </dt> <dd> 421 x 595</dd>
6007<dt> A6 </dt> <dd> 297 x 421</dd>
6008<dt> A7 </dt> <dd> 210 x 297</dd>
6009<dt> A8 </dt> <dd> 148 x 210</dd>
6010<dt> A9 </dt> <dd> 105 x 148</dd>
6011<dt> A10 </dt> <dd> 74 x 105</dd>
6012<dt> B0 </dt> <dd> 2836 x 4008</dd>
6013<dt> B1 </dt> <dd> 2004 x 2836</dd>
6014<dt> B2 </dt> <dd> 1418 x 2004</dd>
6015<dt> B3 </dt> <dd> 1002 x 1418</dd>
6016<dt> B4 </dt> <dd> 709 x 1002</dd>
6017<dt> B5 </dt> <dd> 501 x 709</dd>
6018<dt> C0 </dt> <dd> 2600 x 3677</dd>
6019<dt> C1 </dt> <dd> 1837 x 2600</dd>
6020<dt> C2 </dt> <dd> 1298 x 1837</dd>
6021<dt> C3 </dt> <dd> 918 x 1298</dd>
6022<dt> C4 </dt> <dd> 649 x 918</dd>
6023<dt> C5 </dt> <dd> 459 x 649</dd>
6024<dt> C6 </dt> <dd> 323 x 459</dd>
6025<dt> Flsa </dt> <dd> 612 x 936</dd>
6026<dt> Flse </dt> <dd> 612 x 936</dd>
6027<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6028</dl>
6029
6030<p>This option is also used to place subimages when writing to a multi-image
6031format that supports offsets, such as GIF89 and MNG. When used for this
6032purpose the offsets are always measured from the top left corner of the canvas
6033and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6034position 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
6035file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6036the sequence with nonzero width and height defines the width and height values
6037that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6038height are computed from the bounding box that contains all images in the
6039sequence. When writing a GIF89 file, only the bounding box method is used to
6040determine its dimensions.</p>
6041
Cristy594d2772015-11-15 10:47:42 -05006042<p>For a PostScript page, the image is sized as in <a
6043href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6044left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6045href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006046page. If the image size exceeds the PostScript page, it is reduced to fit the
6047page. 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
6048corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6049present with a value other than <var>NorthWest</var>.</p>
6050
6051<p>The default page dimensions for a TEXT image is 612x792.</p>
6052
6053<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6054
6055<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6056
6057<div style="margin: auto;">
6058 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6059</div>
6060
6061<p class="magick-description">simulate an oil painting.</p>
6062
6063<p>Each pixel is replaced by the most frequent color in a circular
6064neighborhood whose width is specified with <var>radius</var>.</p>
6065
6066<div style="margin: auto;">
6067 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6068
6069<p class="magick-description">write images to this path on disk.</p>
6070
6071<div style="margin: auto;">
6072 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6073</div>
6074
6075<p class="magick-description">Pause between animation loops</p>
6076
6077<p>Pause for the specified number of seconds before repeating the animation.</p>
6078
6079<div style="margin: auto;">
6080 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6081</div>
6082
6083<p class="magick-description">Pause between snapshots.</p>
6084
6085<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6086
6087<div style="margin: auto;">
6088 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6089</div>
6090
6091<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>
6092
6093<div style="margin: auto;">
6094 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6095</div>
6096
6097<p class="magick-description">efficiently determine image characteristics.</p>
6098
6099<div style="margin: auto;">
6100 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6101</div>
6102
6103<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6104
6105<div style="margin: auto;">
6106 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6107</div>
6108
6109<p class="magick-description">simulate a Polaroid picture.</p>
6110
6111<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6112
6113<div style="margin: auto;">
6114 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6115</div>
6116
6117<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>
6118
6119<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>
6120
6121<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>
6122
6123<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6124
6125<p>Some simple uses are:</p>
6126<ul>
6127<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>
6128<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>
6129</ul>
6130
6131<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>
6132
6133<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>
6134
6135
6136<div style="margin: auto;">
6137 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6138</div>
6139
6140<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6141
6142<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6143visible effect.</p>
6144
6145<div style="margin: auto;">
6146 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6147</div>
6148
6149<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6150
6151<div style="margin: auto;">
6152 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6153</div>
6154
6155<p class="magick-description">image preview type.</p>
6156
6157<p>Use this option to affect the preview operation of an image (e.g.
6158<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6159these previews:</p>
6160
6161<pre class="pre-scrollable">
6162AddNoise
6163Blur
6164Brightness
6165Charcoal
6166Despeckle
6167Dull
6168EdgeDetect
6169Gamma
6170Grayscale
6171Hue
6172Implode
6173JPEG
6174OilPaint
6175Quantize
6176Raise
6177ReduceNoise
6178Roll
6179Rotate
6180Saturation
6181Segment
6182Shade
6183Sharpen
6184Shear
6185Solarize
6186Spiff
6187Spread
6188Swirl
6189Threshold
6190Wave
6191</pre>
6192
6193<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6194
6195<p>The default preview is <code>JPEG</code>.</p>
6196
6197<div style="margin: auto;">
6198 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6199</div>
6200
6201<p class="magick-description">interpret string and print to console.</p>
6202
6203<div style="margin: auto;">
6204 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6205</div>
6206
6207<p class="magick-description">process the image with a custom image filter.</p>
6208
6209<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6210argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6211"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6212pass to the process module.</p>
6213
6214<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006215 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006216 +profile <var>profile_name</var></h3>
6217</div>
6218
6219<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6220
6221<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6222ICM (ICC color management), IPTC (newswire information), or a generic profile
6223to the image.</p>
6224
6225<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6226remove the indicated profile. ImageMagick uses standard filename globbing, so
6227wildcard expressions may be used to remove more than one profile. Here we
6228remove all profiles from the image except for the XMP profile: <code>+profile
6229"!xmp,*"</code>. </p>
6230
6231<p>Use <code>identify -verbose</code> to find out which profiles are in the
6232image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6233comments).</p>
6234
6235<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6236used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6237
6238<p>For example, to extract the Exif data (which is stored in JPEG files in the
6239<var>APP1</var> profile), use.</p>
6240
6241<pre>
6242convert cockatoo.jpg profile.exif
6243</pre>
6244
6245<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006246original image already has an included profile. Also, keep in mind that <a
6247href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006248therefore a conversion is made each time it is encountered, in order, in the
6249command-line. For instance, in the following example, if the original image is
6250CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6251
6252<pre>
6253convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6254</pre>
6255
6256<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6257conversion steps can yield unwanted results. CMYK profiles are often very
6258asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6259</p>
6260
6261<div style="margin: auto;">
6262 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6263</div>
6264
6265<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6266
6267<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6268highest compression) to 100 (best quality but least effective compression).
6269The default is to use the estimated quality of your input image if it can
6270be determined, otherwise 92. When the quality is greater than 90, then the
6271chroma channels are not downsampled.
6272Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6273factors for chroma downsampling.</p>
6274
6275<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6276equation to the compression ratio required by the Jasper library. This
6277non-linear equation is intended to loosely approximate the quality provided by
6278the JPEG v1 format. The default quality value 100, a request for non-lossy
6279compression. A quality of 75 results in a request for 16:1 compression.</p>
6280
6281<p>For the MNG and PNG image formats, the quality value sets the zlib
6282compression level (quality / 10) and filter-type (quality % 10). The default
6283PNG "quality" is 75, which means compression level 7 with adaptive PNG
6284filtering, unless the image has a color map, in which case it means
6285compression level 7 with no PNG filtering.</p>
6286
6287<p>For compression level 0 (quality value less than 10), the Huffman-only
6288strategy is used, which is fastest but not necessarily the worst
6289compression.</p>
6290
6291<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6292all scanlines:</p>
6293
6294<dl class="dl-horizontal">
6295<dt>0</dt><dd>none</dd>
6296<dt>1</dt><dd>sub</dd>
6297<dt>2</dt><dd>up</dd>
6298<dt>3</dt><dd>average</dd>
6299<dt>4</dt><dd>Paeth</dd>
6300</dl>
6301
6302<p>If filter-type is 5, adaptive filtering is used when quality is greater
6303than 50 and the image does not have a color map, otherwise no filtering is
6304used.</p>
6305
6306<p>If filter-type is 6, adaptive filtering
6307with <var>minimum-sum-of-absolute-values</var> is used.</p>
6308
6309<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6310transformation (intrapixel differencing) and adaptive filtering
6311with <var>minimum-sum-of-absolute-values</var> are used.</p>
6312
6313<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6314Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6315adaptive PNG filtering.</p>
6316
6317<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6318Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6319no PNG filtering.</p>
6320
6321<p>The quality setting has no effect on the appearance or signature of PNG
6322and MNG images, since the compression is always lossless.</p>
6323
6324<p>Not all combinations of compression level, strategy, and PNG filter type
6325can be obtained using the -quality option. For more precise control,
6326you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6327PNG:compression-filter=N defines, respectively, instead.
6328See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6329over values from the -quality option.</p>
6330
6331<p>For further information, see
6332the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6333
6334<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>
6335
6336<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6337
6338<div style="margin: auto;">
6339 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6340</div>
6341
6342<p class="magick-description">reduce colors using this colorspace.</p>
6343
6344<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006345of colors needed by an image (for later dithering) by operators such as <a
6346href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006347automatically when saving images to color-limited image file formats, such as
6348GIF, and PNG8.</p>
6349
6350
6351<div style="margin: auto;">
6352 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6353</div>
6354
6355<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6356
6357<div style="margin: auto;">
6358 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6359</div>
6360
6361<p class="magick-description">Blur around the center of the image.</p>
6362
6363<p>Note that this is actually a rotational blur rather than a radial and as
6364such actually mis-named. </p>
6365
6366<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6367pixels which are outside the image proper are blurred into the final result.
6368</p>
6369
6370
6371<div style="margin: auto;">
6372 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6373</div>
6374
6375<p class="magick-description">Lighten or darken image edges.</p>
6376
6377<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6378a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6379
Cristy594d2772015-11-15 10:47:42 -05006380<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6381href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006382
6383<div style="margin: auto;">
6384 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6385</div>
6386
6387<p class="magick-description">Apply a random threshold to the image.</p>
6388
6389<div style="margin: auto;">
6390 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6391</div>
6392
6393<p class="magick-description">Set the red chromaticity primary point.</p>
6394
6395<div style="margin: auto;">
6396 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6397</div>
6398
6399<p class="magick-description">Pay attention to warning messages.</p>
6400
6401<p>This option causes some warnings in some image formats to be treated
6402as errors. </p>
6403
6404<div style="margin: auto;">
6405 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6406</div>
6407
6408<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6409
6410<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6411the given colors are dithered over the image as necessary, otherwise the closest
6412color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6413
6414<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6415images in the current image sequence, all the images will have the same color
6416table. That means that when saved to a file format such as GIF, it will use
6417that color table as a single common or global color table, for all the images,
6418without requiring extra local color tables. </p>
6419
6420<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6421sequence to use a common color map over all the images. This equivalent to
6422appending all the images together (without extra background colors) and color
6423reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6424limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6425images. This ensures all the images follow a single color map. </p>
6426
Cristy594d2772015-11-15 10:47:42 -05006427<p>If the number of colors over all the images is less than 256, then <a
6428href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006429no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006430of a global color table. This recommended after using either <a
6431href="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 -04006432reduce the number of colors in an animated image sequence. </p>
6433
6434<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>
6435
6436<div style="margin: auto;">
6437 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6438</div>
6439
6440<p class="magick-description">Set a region in which subsequent operations apply.</p>
6441
6442<p>The <var>x</var> and <var>y</var> offsets are treated
6443in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6444
6445<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6446
6447<p>Use <code>+region</code> to remove any previously set regions.</p>
6448
6449
6450<div style="margin: auto;">
6451 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6452</div>
6453
6454<p class="magick-description">perform a remote operation.</p>
6455
6456<p>The only command recognized is the name of an image file to load.</p>
6457
6458<p>If you have more than one <a href="display.html">display</a> application
6459running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6460specify which application to control.</p>
6461
6462<div style="margin: auto;">
6463 <h3 class="magick-header"><a id="render"></a>-render</h3>
6464</div>
6465
6466<p class="magick-description">render vector operations.</p>
6467
6468<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6469This useful when saving the result to vector formats such as MVG or SVG.</p>
6470
6471<div style="margin: auto;">
6472<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6473</div>
6474
6475<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6476
6477<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6478rather than a setting. You can separately set the canvas size or the offset
6479of the image on that canvas by only providing those components. </p>
6480
6481<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6482
6483<p>If a <code>!</code> flag is given the offset given is added to the existing
6484offset to move the image relative to its previous position. This useful for
6485animation sequences. </p>
6486
6487<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6488recalculate the canvas size so the image (at its current offset) will appear
6489completely on that canvas (unless it has a negative offset).</p>
6490
6491<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6492canvas meta-data from the images. </p>
6493
6494<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6495directly assign virtual canvas meta-data. </p>
6496
6497
6498<div style="margin: auto;">
6499 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6500</div>
6501
6502<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6503
6504<p>Resize the image so that its rendered size remains the same as the original
6505at the specified target resolution. For example, if a 300 DPI image renders at
65063 inches by 2 inches on a 300 DPI device, when the image has been resampled to
650772 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6508only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6509storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006510resolution, the original resolution of the image must be specified via <a
6511href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006512resample resolution.</p>
6513
6514<p>Note that Photoshop stores and obtains image resolution from a proprietary
6515embedded profile. If this profile exists in the image, then Photoshop will
6516continue to treat the image using its former resolution, ignoring the image
6517resolution specified in the standard file header.</p>
6518
6519<div style="margin: auto;">
6520 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6521</div>
6522
6523<p class="magick-description">Resize an image.</p>
6524
6525<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
6526ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6527
6528<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006529or <code>-define filter:option=value</code> precedes the <a
6530href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006531filter.</p>
6532
6533<p>Many image processing algorithms assume your image is in a linear-light
6534coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6535correction, apply the transform, then restore it like this:</p>
6536
6537<pre>
6538convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6539 -quality 92 passport.jpg
6540</pre>
6541
6542<div style="margin: auto;">
6543 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6544</div>
6545
6546<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6547
6548<div style="margin: auto;">
6549 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6550</div>
6551
6552<p class="magick-description">Reverse the order of images in the current image list.</p>
6553
6554
6555<div style="margin: auto;">
6556 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6557</div>
6558
6559<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6560
6561<p>A negative <var>x</var> offset rolls the image right-to-left.
6562A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6563
6564
6565<div style="margin: auto;">
6566 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6567</div>
6568
6569<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6570
6571<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6572height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6573than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6574the image size is 480x640, the image is not rotated. However, if the image is
6575640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6576<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6577misinterpreted as a file redirection.</p>
6578
6579<p>Empty triangles in the corners, left over from rotating the image, are
6580filled with the <code>background</code> color. </p>
6581
6582<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6583'<code>ScaleRotateTranslate</code>' distort method. </p>
6584
6585
6586<div style="margin: auto;">
6587 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6588</div>
6589
6590<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6591
6592<p>Change the image size simply by directly sampling the pixels original
6593from the image. When magnifying, pixels are replicated in blocks. When
6594minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6595over). </p>
6596
6597<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6598a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6599neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6600avoids all the filter processing of the image. As such it completely ignores
6601the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6602
6603<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6604will be added to the resulting image, though some colors may disappear. </p>
6605
6606<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
6607ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6608
6609
6610<p>The actual sampling point is the middle of the sub-region being sampled.
6611As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006612top-left-middle if image has even dimensions). However the <a
6613href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006614this position some other location within each sub-region being sampled, as
6615a percentage offset.</p>
6616
6617<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6618to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6619separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6620sampling sub-region.</p>
6621
6622
6623<div style="margin: auto;">
6624 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6625</div>
6626
6627<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6628
6629<p>This option specifies the sampling factors to be used by the JPEG encoder
6630for chroma downsampling. If this option is omitted, the JPEG library will use
6631its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006632writing the M2V (MPEG-2) format, use <a
6633href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6634href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006635downsampling method.</p>
6636
6637<div style="margin: auto;">
6638 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6639</div>
6640
6641<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6642
6643<p>Change the image size simply by replacing pixels by averaging pixels
6644together when minifying, or replacing pixels when magnifying. </p>
6645
6646<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6647a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6648faster, as it avoids all the filter processing of the image. As such it
6649completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6650
6651<p>If when shrinking (minifying) images the original image is some integer
6652multiple of the new image size, the number of pixels averaged together to
6653produce the new pixel color is the same across the whole image. This is
6654a special case known as 'binning' and is often used as a method of reducing
6655noise in image such as those generated by digital cameras, especially in low
6656light conditions. </p>
6657
6658
6659<div style="margin: auto;">
6660 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6661</div>
6662
6663<p class="magick-description">set scene number.</p>
6664
6665<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6666
6667<div style="margin: auto;">
6668 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6669</div>
6670
6671<p class="magick-description">specify the screen to capture.</p>
6672
6673<p>This option indicates that the GetImage request used to obtain the image
6674should be done on the root window, rather than directly on the specified
6675window. In this way, you can obtain pieces of other windows that overlap the
6676specified window, and more importantly, you can capture menus or other popups
6677that are independent windows but appear over the specified window.</p>
6678
6679<div style="margin: auto;">
6680 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6681</div>
6682
6683<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6684
6685<div style="margin: auto;">
6686 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6687</div>
6688
6689<p class="magick-description">segment the colors of an image.</p>
6690
6691<p>Segment an image by analyzing the histograms of the color components and
6692identifying units that are homogeneous with the fuzzy c-means technique. This
6693is part of the ImageMagick color quantization routines. </p>
6694
6695<p>Specify <var>cluster threshold</var> as the number of pixels in
6696each cluster that must exceed the cluster threshold to be considered valid.
6697<var>Smoothing threshold</var> eliminates noise in the second
6698derivative of the histogram. As the value is increased, you can expect
6699a smoother second derivative. The default is 1.5.</p>
6700
6701<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6702of the color clusters is returned.</p>
6703
6704
6705<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006706 <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 -04006707</div>
6708
6709<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6710
6711<p>Blurs those pixels that are less than or equal to the threshold in
6712contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6713
6714<div style="margin: auto;">
6715 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6716</div>
6717
6718<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>
6719
6720<div style="margin: auto;">
6721 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>threshold</var></h3>
6722</div>
6723
6724<p class="magick-description">simulate a sepia-toned photo.</p>
6725
6726<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6727
6728<p>This option applies a special effect to the image, similar to the effect
6729achieved 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
6730toning. A threshold of 80% is a good starting point for a reasonable
6731tone.</p>
6732
6733
6734
6735<div style="margin: auto;">
6736 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6737 <h3 class="magick-header">+set <var>key</var></h3>
6738</div>
6739
6740<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6741
6742<p>This will assign (or modify) specific settings attached to all the images
6743in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6744option will either remove, or reset that setting to a default state, as
6745appropriate. </p>
6746
6747<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006748'attributes' such as those normally overridden by: the options <a
6749href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6750href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006751assigned before the image is read in, by using a <var>key</var> of
6752the same name. </p>
6753
6754<p>If the given <var>key</var> does not match a specific known
6755'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006756'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6757>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006758</p>
6759
6760<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006761using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6762>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6763a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006764Escapes</a> expanded) to images as they are read in. For example:</p>
6765
6766<pre>
Cristy594d2772015-11-15 10:47:42 -05006767-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006768identify -format %c rose.png
6769Rose is a rose is a rose is a rose
6770</pre>
6771
Cristy594d2772015-11-15 10:47:42 -05006772<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006773Properties</a> in the defined value. For example:</p>
6774
6775<pre>
Cristy594d2772015-11-15 10:47:42 -05006776-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006777 -format 'Old size = %[origsize] New size = %wx%h' info:
6778Old size = 70x46 New size = 35x23
6779</pre>
6780
6781<p>Other well known 'properties' that are available include:
6782'<code>date:create</code>' and '<code>date:modify</code>' and
6783'<code>signature</code>'. </p>
6784
6785<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6786the '<code>page</code>' attribute of an image for images already in memory (also
6787see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6788control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6789option will only provide a direct, unmodified assignment of '<code>page</code>'
6790attribute. </p>
6791
6792<p>This option can also associate a colorspace or profile with your image.
6793For example,</p>
6794
6795<pre>
6796convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6797</pre>
6798
6799<p>Some 'properties' must be defined in a specific way to be used. For
6800example only 'properties' prefixed with "<code>filename:</code>" can be used to
6801modify the output filename of an image. For example</p>
6802
6803<pre>
6804convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6805</pre>
6806
6807<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006808be saved as a global "Artifact" exactly as if it was set using the <a
6809href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006810can be used to pass 'attributes' and 'properties' of one specific image,
6811in a way that allows you to use them in a completely different image, even if
6812the original image has long since been modified or destroyed. For example: </p>
6813
6814<pre>
6815convert rose: -set option:rosesize '%wx%h' -delete 0 \
6816 label:'%[rosesize]' label_size_of_rose.gif"
6817</pre>
6818
Cristy594d2772015-11-15 10:47:42 -05006819<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006820a 'artifact' if the given <var>key</var> does not match an existing
6821'attribute' or 'property'. </p>
6822
6823<p>You can set the attributes of the image registry by prefixing the value
6824with <code>registry:</code>.</p>
6825
6826<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6827previously-formatted ancillary chunks into the output PNG file, using
6828the commandline option as shown below or by setting the profile via a
6829programming interface:</p>
6830
6831<pre>
6832convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6833</pre>
6834
6835<p>where <var>x</var> is a location flag and
6836<var>filename</var> is a file containing the chunk
6837name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6838This encoder will compute the chunk length and CRC, so those must not
6839be included in the file.</p>
6840
6841<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6842or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6843of the same type, then add a short unique string after the "x" to prevent
6844subsequent profiles from overwriting the preceding ones, e.g.,</p>
6845
6846
6847<pre>
6848convert in.png -set profile PNG-chunk-b01:file01 \
6849 -profile PNG-chunk-b02:file02 out.png
6850</pre>
6851
6852<div style="margin: auto;">
6853 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6854</div>
6855
6856<p class="magick-description">shade the image using a distant light source.</p>
6857
6858<p>Specify <var>azimuth</var> and <var>elevation</var> as
6859the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
6860the shading results as a grayscale image.</p>
6861
6862<div style="margin: auto;">
6863 <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>
6864</div>
6865
6866<p class="magick-description">simulate an image shadow.</p>
6867
6868<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006869 <h3 class="magick-header"><a
6870id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04006871</div>
6872
6873<p class="magick-description">use shared memory.</p>
6874
6875<p>This option specifies whether the utility should attempt to use shared
6876memory for pixmaps. ImageMagick must be compiled with shared memory support,
6877and the display must support the <var>MIT-SHM</var> extension.
6878Otherwise, this option is ignored. The default is <code>True</code>.</p>
6879
6880<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006881 <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 -04006882</div>
6883
6884<p class="magick-description">sharpen the image.</p>
6885
6886<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
6887
6888<div style="margin: auto;">
6889 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
6890</div>
6891
6892<p class="magick-description">Shave pixels from the image edges.</p>
6893
6894<p>The <var>size</var> portion of the <var>geometry</var>
6895argument specifies the width of the region to be removed from both sides of
6896the image and the height of the regions to be removed from top and bottom.
6897Offsets are ignored.</p>
6898
6899<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6900
6901<div style="margin: auto;">
6902 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
6903</div>
6904
6905<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
6906
6907<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
6908given, the horizontal component of the shear is performed before the vertical
6909component.</p>
6910
6911<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
6912horizontally or vertically, respectively),creating a parallelogram. The amount
6913of each is controlled by the respective shear angle. For horizontal shears,
6914<var>Xdegrees</var> is measured clockwise relative to "up" (the
6915negative 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
6916positive 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>
6917
6918<p>Empty triangles left over from shearing the image are filled with the color
6919defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
6920using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
6921
6922<p>The horizontal shear is performed before the vertical part. This is
6923important to note, since horizontal and vertical shears do not
6924<var>commute</var>, i.e., the order matters in a sequence of shears. For
6925example, the following two commands are not equivalent.</p>
6926
6927<pre>
6928convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
6929convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
6930</pre>
6931
6932<p>The first of the two commands above is equivalent to the following, except
6933for the amount of empty space created; the command that follows generates
6934a smaller image, and so is a better choice in terms of time and space.</p>
6935
6936<pre>
6937convert logo: -shear 20x60 logo-sheared.png
6938</pre>
6939
6940<div style="margin: auto;">
6941 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
6942</div>
6943
6944<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
6945
6946<p>Increase the contrast of the image using a sigmoidal transfer function
6947without saturating highlights or shadows. <var>Contrast</var>
6948indicates how much to increase the contrast. For example, 0 is none, 3 is
6949typical and 20 is a lot.
6950</p>
6951
6952<p>The <var>mid-point</var> indicates where the maximum change
6953'slope' in contrast should fall in the resultant image (0 is white; 50% is
6954middle-gray; 100% is black). </p>
6955
6956<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
6957
6958<p>To achieve the equivalent of a sigmoidal brightness change (similar to
6959a gamma adjustment), you would use <var>-sigmoidal-contrast
6960{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
6961Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
6962
6963<p>Using a very high <var>contrast</var> will produce a sort of
6964'smoothed thresholding' of the image. Not as sharp (with high aliasing
6965effects) of a true threshold, but with tapered gray-levels around the threshold
6966<var>mid-point</var>. </p>
6967
6968<div style="margin: auto;">
6969 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
6970</div>
6971
6972<p class="magick-description">operate silently.</p>
6973
6974<div style="margin: auto;">
6975 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
6976</div>
6977
6978<p class="magick-description">minimum RMSE for subimage match.</p>
6979
6980<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>
6981
6982<div style="margin: auto;">
6983 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
6984</div>
6985
6986<p class="magick-description">set the width and height of the image.</p>
6987
6988<p>Use this option to specify the width and height of raw images whose
6989dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05006990<code>CMYK</code>. In addition to width and height, use <a
6991href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04006992image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
6993640x512+256).</p>
6994
6995<p>For Photo CD images, choose from these sizes:</p>
6996
6997<pre>
6998192x128
6999384x256
7000768x512
70011536x1024
70023072x2048
7003</pre>
7004
7005<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007006 <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 -04007007</div>
7008
7009<p class="magick-description">simulate a pencil sketch.</p>
7010
7011<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7012angle given is the angle toward which the image is sketched. That is the
7013direction people would consider the object is coming from. </p>
7014
7015<div style="margin: auto;">
7016 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7017</div>
7018
7019<p class="magick-description">smush an image sequence together.</p>
7020
7021<div style="margin: auto;">
7022 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7023</div>
7024
7025<p class="magick-description">Set the number of screen snapshots.</p>
7026
7027<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7028
7029<div style="margin: auto;">
7030 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>threshold</var></h3>
7031</div>
7032
7033<p class="magick-description">negate all pixels above the threshold level.</p>
7034
7035<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7036
7037<p>This option produces a <var>solarization</var> effect seen when
7038exposing a photographic film to light during the development process.</p>
7039
7040<div style="margin: auto;">
7041 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7042</div>
7043
7044<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>
7045
7046
7047<dl class="dl-horizontal">
7048 <dt>barycentric</dt>
7049 <dd>three point triangle of color given 3 points.
7050 Giving only 2 points will form a linear gradient between those points.
7051 The gradient generated extends beyond the triangle created by those
7052 3 points. </dd>
7053 <dt>bilinear</dt>
7054 <dd>Like barycentric but for 4 points. Less than 4 points
7055 fall back to barycentric. </dd>
7056 <dt>voronoi</dt>
7057 <dd>Simply map each pixel to the to nearest color point
7058 given. The result are polygonal 'cells' of solid color. </dd>
7059 <dt>manhatten</dt>
7060 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7061 <dt>shepards</dt>
7062 <dd>Colors points biased on the ratio of inverse distance
7063 squared. Generating spots of color in a sea of the average of
7064 colors. </dd>
7065 <dt>inverse</dt>
7066 <dd>Colors points biased on the ratio of inverse distance.
7067 This generates sharper points of color rather than rounded spots of
7068 '<code>shepards</code>' Generating spots of color in a sea of the
7069 average of colors. </dd>
7070</dl>
7071
7072<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007073canvas (<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 -04007074offset), and do not actually have to exist on the given image, but may be
7075some point beyond the edge of the image. All points are floating point values.
7076</p>
7077
Cristy594d2772015-11-15 10:47:42 -05007078<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007079modified, which means that by default matte/alpha transparency channel is not
7080effected. Typically transparency channel is turned off either before or after
7081the operation. </p>
7082
7083<p>Of course if some color points are transparent to generate a transparent
7084gradient, then the image also requires transparency enabled to store the
7085values. </p>
7086
7087<p>All the above methods when given a single point of color will replace all
7088the colors in the image with the color given, regardless of the point. This is
7089logical, and provides an alternative technique to recolor an image to some
7090default value. </p>
7091
7092
7093<div style="margin: auto;">
7094 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7095</div>
7096
7097<p class="magick-description">Splice the current background color into the image.</p>
7098
Cristy594d2772015-11-15 10:47:42 -05007099<p>This will add rows and columns of the current <a
7100href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007101given <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
7102image into four quadrants, separating them by the inserted rows and columns.
7103</p>
7104
7105<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007106dimension. Similarly using a zero offset with the appropriate <a
7107href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7108the image, padding the image only along that one edge. Edge padding is what <a
7109href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007110
Cristy594d2772015-11-15 10:47:42 -05007111<p>If the exact same <var>geometry</var> and <a
7112href="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 -04007113added added all splices removed. </p>
7114
7115<div style="margin: auto;">
7116 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7117</div>
7118
7119<p class="magick-description">displace image pixels by a random amount.</p>
7120
7121<p>The argument <var>amount</var> defines the size of the
7122neighborhood around each pixel from which to choose a candidate pixel to
7123blend.</p>
7124
7125<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7126
7127<div style="margin: auto;">
7128 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7129</div>
7130
7131<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7132
7133<p>Choose from these statistic types:</p>
7134<dl class="dl-horizontal">
7135<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7136<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7137<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7138<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7139<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7140<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7141<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7142<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7143<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7144</dl>
7145
7146<div style="margin: auto;">
7147 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7148</div>
7149
7150<p class="magick-description">hide watermark within an image.</p>
7151
7152<p>Use an offset to start the image hiding some number of pixels from the
7153beginning of the image. Note this offset and the image size. You will need
7154this information to recover the steganographic image (e.g. display -size
7155320x256+35 stegano:image.png).</p>
7156
7157<div style="margin: auto;">
7158 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7159</div>
7160
7161<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7162
7163<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>
7164
7165<div style="margin: auto;">
7166 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7167</div>
7168
7169<p class="magick-description">pixel storage type. Here are the valid types:</p>
7170
7171<dl class="dl-horizontal">
7172<dt>char</dt><dd>unsigned characters</dd>
7173<dt>double</dt><dd>doubles</dd>
7174<dt>float</dt><dd>floats</dd>
7175<dt>integer</dt><dd>integers</dd>
7176<dt>long</dt><dd>longs</dd>
7177<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7178<dt>short</dt><dd>unsigned shorts</dd>
7179</dl>
7180
7181<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7182values range from 0 to the maximum value the storage type can support.</p>
7183
7184<div style="margin: auto;">
7185 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7186</div>
7187
7188<p class="magick-description">Set a type of stretch style for fonts.</p>
7189
7190<p>This setting suggests a type of stretch that ImageMagick should try to
7191apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7192
7193<pre>
7194Any
7195Condensed
7196Expanded
7197ExtraCondensed
7198ExtraExpanded
7199Normal
7200SemiCondensed
7201SemiExpanded
7202UltraCondensed
7203UltraExpanded
7204</pre>
7205
7206<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7207stretch</a>.</p>
7208
Cristy594d2772015-11-15 10:47:42 -05007209<p>For other settings that affect fonts, see the options <a
7210href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7211href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007212
7213<div style="margin: auto;">
7214 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7215</div>
7216
7217<p class="magick-description">strip the image of any profiles or comments.</p>
7218
7219<div style="margin: auto;">
7220 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7221</div>
7222
7223<p class="magick-description">color to use when stroking a graphic primitive.</p>
7224
7225<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7226
7227<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7228
7229<div style="margin: auto;">
7230 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7231</div>
7232
7233<p class="magick-description">set the stroke width.</p>
7234
7235<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7236
7237<div style="margin: auto;">
7238 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7239</div>
7240
7241<p class="magick-description">Set a font style for text.</p>
7242
7243<p>This setting suggests a font style that ImageMagick should try to apply to
7244the currently selected font family. Select <var>fontStyle</var> from
7245the following.</p>
7246
7247<pre>
7248Any
7249Italic
7250Normal
7251Oblique
7252</pre>
7253
Cristy594d2772015-11-15 10:47:42 -05007254<p>For other settings that affect fonts, see the options <a
7255href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7256href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007257
7258<div style="margin: auto;">
7259 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7260</div>
7261
7262<p class="magick-description">search for subimage.</p>
7263
7264<p>This option is required to have compare search for the best match location
7265of a small image within a larger image. This search will produce two images
7266(or two frames). The first is the "difference" image and the second will
7267be the "match score" image.</p>
7268
7269<p>The "match-score" image is smaller containing a pixel for ever possible
7270position of the top-left corner of the given sub-image. that is its size will
7271be the size of the larger_image - sub_image + 1. The brightest location in
7272this image is the location s the locate on the best match that is also
7273reported. Note that this may or may not be a perfect match, and the actual
7274brightness will reflect this. Other bright 'peaks' can be used to locate other
7275possible matching locations. </p>
7276
7277<p>Note that the search will try to compare the sub-image at every possible
7278location in the larger image, as such it can be very slow. The smaller the
7279sub-image the faster this search is. </p>
7280
7281
7282<div style="margin: auto;">
7283 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7284</div>
7285
7286<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7287
7288<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7289images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7290the last two images in the sequence.</p>
7291
7292<div style="margin: auto;">
7293 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7294</div>
7295
7296<p class="magick-description">swirl image pixels about the center.</p>
7297
7298<p><var>Degrees</var> defines the tightness of the swirl.</p>
7299
7300<div style="margin: auto;">
7301 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7302</div>
7303
7304<p class="magick-description">synchronize image to storage device.</p>
7305
7306<p>Set to "true" to ensure all image data is fully flushed and synchronized
7307to disk. There is a performance penalty, but the benefits include ensuring a
7308valid image file in the event of a system crash and early reporting if there
7309is not enough disk space for the image pixel cache.</p>
7310
7311<div style="margin: auto;">
7312 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7313</div>
7314
7315<p class="magick-description">Mark the image as modified.</p>
7316
7317<div style="margin: auto;">
7318 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7319</div>
7320
7321<p class="magick-description">font for writing fixed-width text.</p>
7322
7323<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7324formatted text. The default is 14 point <var>Courier</var>.</p>
7325
7326<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7327OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7328<code>x:fixed</code> is OPTION1.</p>
7329
7330<div style="margin: auto;">
7331 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7332</div>
7333
7334<p class="magick-description">name of texture to tile onto the image background.</p>
7335
7336<div style="margin: auto;">
7337 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7338</div>
7339
7340<!-- {<var>green,blue,opacity</var>}
7341<p>If the green or blue value is omitted, these channels use the same value as
7342the first one provided. If all three color values are the same, the result is
7343a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7344and any partially transparent pixel becomes fully transparent.</p>
7345-->
7346
7347<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7348
Cristy594d2772015-11-15 10:47:42 -05007349<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 -04007350maximum channel value, while all other values are assigned the minimum.</p>
7351
7352<p> The threshold value can be given as a percentage or as an absolute integer
7353value corresponding to the desired channel value. When given as an integer,
7354the minimum attainable value is 0 (corresponding to black when all channels
7355are affected), but the maximum value (corresponding to white) is that of the
7356<code>quantum depth</code> of the particular build of ImageMagick, and is
7357therefore dependent on the installation. For that reason, a reasonable
7358recommendation for most applications is to specify the threshold values as
7359a percentage. </p>
7360
7361<p> The following would force pixels with red values above 50% to have 100%
7362red values, while those at or below 50% red would be set to 0 in the red
7363channel. The green, blue, and alpha channels (if present) would be unchanged.
7364</p>
7365
7366<pre>
7367convert in.png -channel red -threshold 50% out.png
7368</pre>
7369
7370<p>As (possibly) impractical but instructive examples, the following would
7371generate an all-black and an all-white image with the same dimensions as the
7372input image.</p>
7373
7374
7375<pre>
7376convert in.png -threshold 100% black.png
7377convert in.png -threshold -1 white.png
7378</pre>
7379
7380<p>Note that the values of the transparency channel is treated as 'matte'
7381values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7382
Cristy594d2772015-11-15 10:47:42 -05007383<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 -04007384</p>
7385
7386<div style="margin: auto;">
7387 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7388</div>
7389
7390<p class="magick-description">Create a thumbnail of the image.</p>
7391
7392<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7393for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007394reduce the thumbnail size. To strip the color profiles as well, add <a
7395href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007396
7397<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7398
7399<div style="margin: auto;">
7400 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7401</div>
7402
7403<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7404
7405<div style="margin: auto;">
7406 <h3 class="magick-header">-tile <var>geometry</var></h3>
7407</div>
7408
7409<p class="magick-description">Specify the layout of images.</p>
7410
7411<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7412
7413<div style="margin: auto;">
7414 <h3 class="magick-header">-tile</h3>
7415</div>
7416
7417<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7418
7419<div style="margin: auto;">
7420 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7421</div>
7422
7423<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7424
Cristy594d2772015-11-15 10:47:42 -05007425<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7426>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007427creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7428formats. </p>
7429
Cristy594d2772015-11-15 10:47:42 -05007430<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007431by the arguments given when the tile image is set. </p>
7432
7433<div style="margin: auto;">
7434 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7435</div>
7436
7437<p class="magick-description">Tint the image with the fill color.</p>
7438
7439<p>Tint the image with the fill color.</p>
7440
7441<p>Specify the amount of tinting as a percentage. Pure colors like black,
7442white red, yellow, will not be affected by -tint. Only mid-range colors such
7443as the various shades of grey.</p>
7444
7445<div style="margin: auto;">
7446 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7447</div>
7448
7449<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7450
7451<p>Use this option to assign a specific title to the image. This assigned to
7452the image window and is typically displayed in the window title bar.
7453Optionally you can include the image filename, type, width, height, Exif data,
7454or other image attribute by embedding special format characters described
7455under the <a href="command-line-options.html#format">-format</a> option.</p>
7456
7457<p>For example,</p>
7458
7459<pre>
7460-title "%m:%f %wx%h"
7461</pre>
7462
7463<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7464titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7465
7466
7467<div style="margin: auto;">
7468 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7469</div>
7470
7471<p class="magick-description">transform the image.</p>
7472
7473<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7474
7475<pre>
7476convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7477</pre>
7478
7479
Cristy594d2772015-11-15 10:47:42 -05007480<p>This operator has been now been superseded by the <a
7481href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007482
7483
7484<div style="margin: auto;">
7485 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7486</div>
7487
7488<p class="magick-description">Make this color transparent within the image.</p>
7489
7490<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007491described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7492>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007493given. </p>
7494
Cristy594d2772015-11-15 10:47:42 -05007495<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007496that is make all non-matching colors transparent. </p>
7497
Cristy594d2772015-11-15 10:47:42 -05007498<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7499href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007500current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007501However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7502that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7503>-alpha</a> set</code>", and does not require you to modify the <a
7504href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007505
7506<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007507used for color-mapped image formats, such as GIF. For that use <a
7508href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007509
7510
7511<div style="margin: auto;">
7512 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7513</div>
7514
7515<p class="magick-description">Set the transparent color.</p>
7516
7517<p>Sometimes this is used for saving to image formats such as
7518GIF and PNG8 which uses this color to represent boolean transparency. This
7519does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007520color is in the color palette of the saved image. Use <a
7521href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007522
7523<p>This option allows you to have both an opaque visible color, as well as a
7524transparent color of the same color value without conflict. That is, you can
7525use the same color for both the transparent and opaque color areas within an
7526image. This, in turn, frees to you to select a transparent color that is
7527appropriate when an image is displayed by an application that does not handle a
7528transparent color index, while allowing ImageMagick to correctly handle images of this
7529type. </p>
7530
7531<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7532
7533<div style="margin: auto;">
7534 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7535</div>
7536
7537<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7538
7539<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7540</p>
7541
7542<div style="margin: auto;">
7543 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7544</div>
7545
7546<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>
7547
7548
7549<div style="margin: auto;">
7550 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7551</div>
7552
7553<p class="magick-description">tree depth for the color reduction algorithm.</p>
7554
7555<p>Normally, this integer value is zero or one. A value of zero or one causes
7556the use of an optimal tree depth for the color reduction algorithm.</p>
7557
7558<p>An optimal depth generally allows the best representation of the source
7559image with the fastest computational speed and the least amount of memory.
7560However, the default depth is inappropriate for some images. To assure the
7561best representation, try values between 2 and 8 for this parameter. Refer to
Cristy594d2772015-11-15 10:47:42 -05007562the <a href="quantize.html"
7563>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007564
7565<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7566option, or writing to an image format which requires color reduction, is
7567required for this option to take effect.</p>
7568
7569<div style="margin: auto;">
7570 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7571</div>
7572
7573<p class="magick-description">trim an image.</p>
7574
7575<p>This option removes any edges that are exactly the same color as the corner
7576pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7577edges that are nearly the same color as the corner pixels.</p>
7578
7579<p>The page or virtual canvas information of the image is preserved allowing
7580you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7581image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7582information if it is unwanted.</p>
7583
7584<p>If the trimmed image 'disappears' an warning is produced, and a special
7585single pixel transparent 'missed' image is returned, in the same way as when a
7586<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7587
7588
7589<div style="margin: auto;">
7590 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7591</div>
7592
7593<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7594<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7595<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7596<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7597
7598<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007599truecolor, the encoder will try to choose an efficient subformat. The <a
7600href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007601example, to prevent a JPEG from being written in grayscale format even though
7602only gray pixels are present, use.</p>
7603
7604<pre>
7605convert bird.png -type TrueColor bird.jpg
7606</pre>
7607
7608<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7609encoder to write an alpha channel even though the image is opaque, if the
7610output format supports transparency.</p>
7611
7612<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>
7613
7614<div style="margin: auto;">
7615 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7616</div>
7617
7618<p class="magick-description">set the color of the annotation bounding box.</p>
7619
7620<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7621
7622<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7623
7624
7625<div style="margin: auto;">
7626 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7627</div>
7628
7629<p class="magick-description">detect when image file is modified and redisplay.</p>
7630
7631<p>Suppose that while you are displaying an image the file that is currently
7632displayed is over-written. <code>display</code> will automagically detect that
7633the input file has been changed and update the displayed image
7634accordingly.</p>
7635
7636
7637<div style="margin: auto;">
7638 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7639</div>
7640
7641<p class="magick-description">discard all but one of any pixel color.</p>
7642
7643
7644<div style="margin: auto;">
7645 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7646</div>
7647
7648<p class="magick-description">the units of image resolution.</p>
7649
7650<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7651<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7652with the <a href="command-line-options.html#density">-density</a> option.</p>
7653
7654
7655<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007656 <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 -04007657</div>
7658
7659<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7660
7661<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7662convolved with a Gaussian operator of the given radius and standard deviation
7663(sigma). For reasonable results, radius should be larger than sigma. Use
7664a radius of 0 to have the method select a suitable radius.</p>
7665
7666<p>The parameters are:</p>
7667
7668<dl class="dl-horizontal">
7669<dt>radius</dt>
7670<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7671<dt>sigma</dt>
7672<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7673<dt>gain</dt>
7674<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7675<dt>threshold</dt>
7676<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7677</dl>
7678
7679<div style="margin: auto;">
7680 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7681</div>
7682
7683<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>
7684
7685
7686<div style="margin: auto;">
7687 <h3 class="magick-header"><a id="version"></a>-version</h3>
7688</div>
7689
7690<p class="magick-description">print ImageMagick version string and exit.</p>
7691
7692
7693<div style="margin: auto;">
7694 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7695</div>
7696
7697<p class="magick-description">FlashPix viewing parameters.</p>
7698
7699
7700<div style="margin: auto;">
7701 <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>
7702</div>
7703
7704<p class="magick-description">soften the edges of the image in vignette style.</p>
7705
7706<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>
7707
7708<div style="margin: auto;">
7709 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7710</div>
7711
7712<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7713
7714<p>This option defines what color source should be used if and when a color
7715lookup completely 'misses' the source image. The color(s) that appear to
7716surround the source image. Generally this color is derived from the source
7717image, but could also be set to a specify background color. </p>
7718
7719<p>Choose from these methods:</p>
7720
7721<dl class="dl-horizontal">
7722<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7723<dt>black</dt><dd>the area surrounding the image is black</dd>
7724<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7725<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7726<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7727<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7728<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7729<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7730<dt>mirror</dt><dd>mirror tile the image</dd>
7731<dt>random</dt><dd>choose a random pixel from the image</dd>
7732<dt>tile</dt><dd>tile the image (default)</dd>
7733<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7734<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7735<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7736<dt>white</dt><dd>the area surrounding the image is white</dd>
7737</dl>
7738
7739<p>The default value is "edge".</p>
7740
Cristy594d2772015-11-15 10:47:42 -05007741<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7742>-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 -04007743However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007744image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7745href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007746
Cristy594d2772015-11-15 10:47:42 -05007747<p>To print a complete list of virtual pixel types, use the <a
7748href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007749
7750
7751<div style="margin: auto;">
7752 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7753</div>
7754
7755<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7756
7757<p>Choose from these visual classes:</p>
7758
7759<pre>
7760StaticGray TrueColor
7761GrayScale DirectColor
7762StaticColor default
7763PseudoColor visual id
7764</pre>
7765
7766<p>The X server must support the visual you choose, otherwise an error occurs.
7767If a visual is not specified, the visual class that can display the most
7768simultaneous colors on the default screen is chosen.</p>
7769
7770
7771<div style="margin: auto;">
7772 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7773</div>
7774
7775<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7776
7777<p>Take a grayscale image (with alpha mask) and modify the destination image's
7778brightness according to watermark image's grayscale value and the
7779<var>brightness</var> percentage. The destinations color saturation
7780attribute is just direct modified by the <var>saturation</var>
7781percentage, which defaults to 100 percent (no color change). </p>
7782
7783
7784<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007785 <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 -04007786</div>
7787
7788<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7789
7790<p>Specify <var>amplitude</var> and <var>wavelength</var>
7791of the wave.</p>
7792
7793<div style="margin: auto;">
7794 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7795</div>
7796
7797<p class="magick-description">Set a font weight for text.</p>
7798
7799<p>This setting suggests a font weight that ImageMagick should try to apply to
7800the currently selected font family. Use a positive integer for
7801<var>fontWeight</var> or select from the following.</p>
7802
7803<dl class="dl-horizontal">
7804<dt>Thin </dt>
7805<dd>Same as <var>fontWeight</var> = 100.</dd>
7806<dt>ExtraLight </dt>
7807<dd>Same as <var>fontWeight</var> = 200.</dd>
7808<dt>Light </dt>
7809<dd>Same as <var>fontWeight</var> = 300.</dd>
7810<dt>Normal </dt>
7811<dd>Same as <var>fontWeight</var> = 400.</dd>
7812<dt>Medium </dt>
7813<dd>Same as <var>fontWeight</var> = 500.</dd>
7814<dt>DemiBold </dt>
7815<dd>Same as <var>fontWeight</var> = 600.</dd>
7816<dt>Bold </dt>
7817<dd>Same as <var>fontWeight</var> = 700.</dd>
7818<dt>ExtraBold </dt>
7819<dd>Same as <var>fontWeight</var> = 800.</dd>
7820<dt>Heavy </dt>
7821<dd>Same as <var>fontWeight</var> = 900.</dd>
7822</dl>
Cristy594d2772015-11-15 10:47:42 -05007823<br/>
Cristy882d9f42015-10-29 16:48:39 -04007824
7825<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7826
Cristy594d2772015-11-15 10:47:42 -05007827<p>For other settings that affect fonts, see the options <a
7828href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7829href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007830
7831<div style="margin: auto;">
7832 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
7833</div>
7834
7835<p class="magick-description">chromaticity white point.</p>
7836
7837<div style="margin: auto;">
7838 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7839</div>
7840
7841<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7842
7843<p> The threshold value can be given as a percentage or as an absolute integer
7844value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05007845desired <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 -04007846
7847<div style="margin: auto;">
7848 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
7849</div>
7850
7851<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7852
7853<p><var>id</var> can be a window id or name. Specify <code>root</code>
7854to select X's root window as the target window.</p>
7855
7856<p>By default the image is tiled onto the background of the target window. If
7857<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
7858image is surrounded by the background color. Refer to <code>X RESOURCES</code>
7859for details.</p>
7860
7861<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05007862colors than the target window colormap allows. Use <a
7863href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04007864
7865<div style="margin: auto;">
7866 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
7867</div>
7868
7869<p class="magick-description">specify the window group.</p>
7870
7871<div style="margin: auto;">
7872 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
7873</div>
7874
7875<p class="magick-description">write an image sequence.</p>
7876
7877<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>
7878
7879<p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
7880</div>
7881</div>
7882
7883
7884 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00007885 <p><a href="support.html">Donate</a>
7886 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00007887 <a href="links.html">Related</a>
cristy29f2c972015-07-28 13:37:46 +00007888 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00007889</p>
7890 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00007891 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
cristy5b8fe762015-06-09 16:24:03 +00007892 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyb57c2352015-08-25 20:01:06 -04007893 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00007894 </footer>
7895</div><!-- /.container -->
7896
Cristy542697a2015-10-12 20:10:32 -04007897 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +00007898 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00007899</div>
cristyad41c0c2012-10-31 00:49:28 +00007900</body>
cristy5a367e42015-05-05 12:39:18 +00007901</html>