8 <meta charset="utf-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
10 <title>Command-line Options @ ImageMagick</title>
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="https://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-2017 ImageMagick Studio LLC" />
23 <meta name="distribution" content="Global" />
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
25 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
26 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
27 <link href="../www/command-line-options.html" rel="canonical" />
28 <link href="../images/wand.png" rel="icon" />
29 <link href="../images/wand.ico" rel="shortcut icon" />
30 <link href="assets/magick.css" rel="stylesheet" />
34 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
35 <a class="navbar-brand" href="../index.html"><img class="d-block" id="logo" name="ImageMagick" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
36 <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
37 <span class="navbar-toggler-icon"></span>
40 <div class="navbar-collapse collapse" id="navbarsExampleDefault" style="">
41 <ul class="navbar-nav mr-auto">
42 <li class="nav-item ">
43 <a class="nav-link" href="../index.html">Home <span class="sr-only">(current)</span></a>
45 <li class="nav-item ">
46 <a class="nav-link" href="download.html">Download</a>
48 <li class="nav-item ">
49 <a class="nav-link" href="command-line-tools.html">Tools</a>
51 <li class="nav-item ">
52 <a class="nav-link" href="command-line-processing.html">Command-line</a>
54 <li class="nav-item ">
55 <a class="nav-link" href="resources.html">Resources</a>
57 <li class="nav-item ">
58 <a class="nav-link" href="develop.html">Develop</a>
61 <a class="nav-link" target="_blank" href="https://www.imagemagick.org/discourse-server/">Community</a>
64 <form class="form-inline my-2 my-lg-0" action="https://www.imagemagick.org/script/search.php">
65 <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
66 <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
70 <div class="container">
71 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
73 data-ad-client="ca-pub-3129977114552745"
74 data-ad-slot="6345125851"
75 data-ad-format="auto"></ins>
77 (adsbygoogle = window.adsbygoogle || []).push({});
81 <main role="main" class="container">
82 <div class="magick-template">
83 <div class="magick-header">
84 <p class="text-center"><a href="command-line-options.html#adaptive-blur">‑adaptive‑blur</a> • <a href="command-line-options.html#adaptive-resize">‑adaptive‑resize</a> • <a href="command-line-options.html#adaptive-sharpen">‑adaptive‑sharpen</a> • <a href="command-line-options.html#adjoin">‑adjoin</a> • <a href="command-line-options.html#affine">‑affine</a> • <a href="command-line-options.html#alpha">‑alpha</a> • <a href="command-line-options.html#annotate">‑annotate</a> • <a href="command-line-options.html#antialias">‑antialias</a> • <a href="command-line-options.html#append">‑append</a> • <a href="command-line-options.html#attenuate">‑attenuate</a> • <a href="command-line-options.html#authenticate">‑authenticate</a> • <a href="command-line-options.html#auto-gamma">‑auto‑gamma</a> • <a href="command-line-options.html#auto-level">‑auto‑level</a> • <a href="command-line-options.html#auto-orient">‑auto‑orient</a> • <a href="command-line-options.html#auto-threshold">‑auto‑threshold</a> • <a href="command-line-options.html#backdrop">‑backdrop</a> • <a href="command-line-options.html#background">‑background</a> • <a href="command-line-options.html#bench">‑bench</a> • <a href="command-line-options.html#bias">‑bias</a> • <a href="command-line-options.html#black-point-compensation">‑black‑point‑compensation</a> • <a href="command-line-options.html#black-threshold">‑black‑threshold</a> • <a href="command-line-options.html#blend">‑blend</a> • <a href="command-line-options.html#blue-primary">‑blue‑primary</a> • <a href="command-line-options.html#blue-shift">‑blue‑shift</a> • <a href="command-line-options.html#blur">‑blur</a> • <a href="command-line-options.html#border">‑border</a> • <a href="command-line-options.html#bordercolor">‑bordercolor</a> • <a href="command-line-options.html#borderwidth">‑borderwidth</a> • <a href="command-line-options.html#brightness-contrast">‑brightness‑contrast</a> • <a href="command-line-options.html#cache">‑cache</a> • <a href="command-line-options.html#canny">‑canny</a> • <a href="command-line-options.html#caption">‑caption</a> • <a href="command-line-options.html#cdl">‑cdl</a> • <a href="command-line-options.html#channel">‑channel</a> • <a href="command-line-options.html#charcoal">‑charcoal</a> • <a href="command-line-options.html#channel-fx">‑channel‑fx</a> • <a href="command-line-options.html#chop">‑chop</a> • <a href="command-line-options.html#clamp">‑clamp</a> • <a href="command-line-options.html#clip">‑clip</a> • <a href="command-line-options.html#clip-mask">‑clip‑mask</a> • <a href="command-line-options.html#clip-path">‑clip‑path</a> • <a href="command-line-options.html#clone">‑clone</a> • <a href="command-line-options.html#clut">‑clut</a> • <a href="command-line-options.html#coalesce">‑coalesce</a> • <a href="command-line-options.html#colorize">‑colorize</a> • <a href="command-line-options.html#colormap">‑colormap</a> • <a href="command-line-options.html#color-matrix">‑color‑matrix</a> • <a href="command-line-options.html#colors">‑colors</a> • <a href="command-line-options.html#colorspace">‑colorspace</a> • <a href="command-line-options.html#combine">‑combine</a> • <a href="command-line-options.html#comment">‑comment</a> • <a href="command-line-options.html#compare">‑compare</a> • <a href="command-line-options.html#complex">‑complex</a> • <a href="command-line-options.html#compose">‑compose</a> • <a href="command-line-options.html#composite">‑composite</a> • <a href="command-line-options.html#compress">‑compress</a> • <a href="command-line-options.html#connected-components">‑connected‑components</a> • <a href="command-line-options.html#contrast">‑contrast</a> • <a href="command-line-options.html#contrast-stretch">‑contrast‑stretch</a> • <a href="command-line-options.html#convolve">‑convolve</a> • <a href="command-line-options.html#copy">‑copy</a> • <a href="command-line-options.html#crop">‑crop</a> • <a href="command-line-options.html#cycle">‑cycle</a> • <a href="command-line-options.html#debug">‑debug</a> • <a href="command-line-options.html#decipher">‑decipher</a> • <a href="command-line-options.html#deconstruct">‑deconstruct</a> • <a href="command-line-options.html#define">‑define</a> • <a href="command-line-options.html#delay">‑delay</a> • <a href="command-line-options.html#delete">‑delete</a> • <a href="command-line-options.html#density">‑density</a> • <a href="command-line-options.html#depth">‑depth</a> • <a href="command-line-options.html#descend">‑descend</a> • <a href="command-line-options.html#deskew">‑deskew</a> • <a href="command-line-options.html#despeckle">‑despeckle</a> • <a href="command-line-options.html#direction">‑direction</a> • <a href="command-line-options.html#displace">‑displace</a> • <a href="command-line-options.html#display">‑display</a> • <a href="command-line-options.html#dispose">‑dispose</a> • <a href="command-line-options.html#dissimilarity-threshold">‑dissimilarity‑threshold</a> • <a href="command-line-options.html#dissolve">‑dissolve</a> • <a href="command-line-options.html#distort">‑distort</a> • <a href="command-line-options.html#distribute-cache">‑distribute‑cache</a> • <a href="command-line-options.html#dither">‑dither</a> • <a href="command-line-options.html#draw">‑draw</a> • <a href="command-line-options.html#duplicate">‑duplicate</a> • <a href="command-line-options.html#edge">‑edge</a> • <a href="command-line-options.html#emboss">‑emboss</a> • <a href="command-line-options.html#encipher">‑encipher</a> • <a href="command-line-options.html#encoding">‑encoding</a> • <a href="command-line-options.html#endian">‑endian</a> • <a href="command-line-options.html#enhance">‑enhance</a> • <a href="command-line-options.html#equalize">‑equalize</a> • <a href="command-line-options.html#evaluate">‑evaluate</a> • <a href="command-line-options.html#evaluate-sequence">‑evaluate‑sequence</a> • <a href="command-line-options.html#extent">‑extent</a> • <a href="command-line-options.html#extract">‑extract</a> • <a href="command-line-options.html#family">‑family</a> • <a href="command-line-options.html#features">‑features</a> • <a href="command-line-options.html#fft">‑fft</a> • <a href="command-line-options.html#fill">‑fill</a> • <a href="command-line-options.html#filter">‑filter</a> • <a href="command-line-options.html#flatten">‑flatten</a> • <a href="command-line-options.html#flip">‑flip</a> • <a href="command-line-options.html#floodfill">‑floodfill</a> • <a href="command-line-options.html#flop">‑flop</a> • <a href="command-line-options.html#font">‑font</a> • <a href="command-line-options.html#foreground">‑foreground</a> • <a href="command-line-options.html#format">‑format</a> • <a href="command-line-options.html#format_identify_">‑format[identify]</a> • <a href="command-line-options.html#frame">‑frame</a> • <a href="command-line-options.html#frame_import_">‑frame[import]</a> • <a href="command-line-options.html#function">‑function</a> • <a href="command-line-options.html#fuzz">‑fuzz</a> • <a href="command-line-options.html#fx">‑fx</a> • <a href="command-line-options.html#gamma">‑gamma</a> • <a href="command-line-options.html#gaussian-blur">‑gaussian‑blur</a> • <a href="command-line-options.html#geometry">‑geometry</a> • <a href="command-line-options.html#gravity">‑gravity</a> • <a href="command-line-options.html#grayscale">‑grayscale</a> • <a href="command-line-options.html#green-primary">‑green‑primary</a> • <a href="command-line-options.html#hald-clut">‑hald‑clut</a> • <a href="command-line-options.html#help">‑help</a> • <a href="command-line-options.html#highlight-color">‑highlight‑color</a> • <a href="command-line-options.html#hough-lines">‑hough‑lines</a> • <a href="command-line-options.html#iconGeometry">‑iconGeometry</a> • <a href="command-line-options.html#iconic">‑iconic</a> • <a href="command-line-options.html#identify">‑identify</a> • <a href="command-line-options.html#ift">‑ift</a> • <a href="command-line-options.html#immutable">‑immutable</a> • <a href="command-line-options.html#implode">‑implode</a> • <a href="command-line-options.html#insert">‑insert</a> • <a href="command-line-options.html#intensity">‑intensity</a> • <a href="command-line-options.html#intent">‑intent</a> • <a href="command-line-options.html#interlace">‑interlace</a> • <a href="command-line-options.html#interpolate">‑interpolate</a> • <a href="command-line-options.html#interline-spacing">‑interline‑spacing</a> • <a href="command-line-options.html#interword-spacing">‑interword‑spacing</a> • <a href="command-line-options.html#kerning">‑kerning</a> • <a href="command-line-options.html#kuwahara">‑kuwahara</a> • <a href="command-line-options.html#label">‑label</a> • <a href="command-line-options.html#lat">‑lat</a> • <a href="command-line-options.html#layers">‑layers</a> • <a href="command-line-options.html#level">‑level</a> • <a href="command-line-options.html#level-colors">‑level‑colors</a> • <a href="command-line-options.html#limit">‑limit</a> • <a href="command-line-options.html#linear-stretch">‑linear‑stretch</a> • <a href="command-line-options.html#linewidth">‑linewidth</a> • <a href="command-line-options.html#liquid-rescale">‑liquid‑rescale</a> • <a href="command-line-options.html#list">‑list</a> • <a href="command-line-options.html#log">‑log</a> • <a href="command-line-options.html#loop">‑loop</a> • <a href="command-line-options.html#lowlight-color">‑lowlight‑color</a> • <a href="command-line-options.html#magnify">‑magnify</a> • <a href="command-line-options.html#map">‑map</a> • <a href="command-line-options.html#map_stream_">‑map[stream]</a> • <a href="command-line-options.html#mattecolor">‑mattecolor</a> • <a href="command-line-options.html#median">‑median</a> • <a href="command-line-options.html#mean-shift">‑mean‑shift</a> • <a href="command-line-options.html#metric">‑metric</a> • <a href="command-line-options.html#mode">‑mode</a> • <a href="command-line-options.html#modulate">‑modulate</a> • <a href="command-line-options.html#moments">‑moments</a> • <a href="command-line-options.html#monitor">‑monitor</a> • <a href="command-line-options.html#monochrome">‑monochrome</a> • <a href="command-line-options.html#morph">‑morph</a> • <a href="command-line-options.html#morphology">‑morphology</a> • <a href="command-line-options.html#mosaic">‑mosaic</a> • <a href="command-line-options.html#motion-blur">‑motion‑blur</a> • <a href="command-line-options.html#name">‑name</a> • <a href="command-line-options.html#negate">‑negate</a> • <a href="command-line-options.html#noise">‑noise</a> • <a href="command-line-options.html#normalize">‑normalize</a> • <a href="command-line-options.html#opaque">‑opaque</a> • <a href="command-line-options.html#ordered-dither">‑ordered‑dither</a> • <a href="command-line-options.html#orient">‑orient</a> • <a href="command-line-options.html#page">‑page</a> • <a href="command-line-options.html#paint">‑paint</a> • <a href="command-line-options.html#path">‑path</a> • <a href="command-line-options.html#pause_animate_">‑pause[animate]</a> • <a href="command-line-options.html#pause_import_">‑pause[import]</a> • <a href="command-line-options.html#perceptible">‑perceptible</a> • <a href="command-line-options.html#ping">‑ping</a> • <a href="command-line-options.html#pointsize">‑pointsize</a> • <a href="command-line-options.html#polaroid">‑polaroid</a> • <a href="command-line-options.html#poly">‑poly</a> • <a href="command-line-options.html#posterize">‑posterize</a> • <a href="command-line-options.html#precision">‑precision</a> • <a href="command-line-options.html#preview">‑preview</a> • <a href="command-line-options.html#print">‑print</a> • <a href="command-line-options.html#process">‑process</a> • <a href="command-line-options.html#profile">‑profile</a> • <a href="command-line-options.html#quality">‑quality</a> • <a href="command-line-options.html#quantize">‑quantize</a> • <a href="command-line-options.html#quiet">‑quiet</a> • <a href="command-line-options.html#radial-blur">‑radial‑blur</a> • <a href="command-line-options.html#raise">‑raise</a> • <a href="command-line-options.html#random-threshold">‑random‑threshold</a> • <a href="command-line-options.html#read-mask">‑read‑mask</a> • <a href="command-line-options.html#red-primary">‑red‑primary</a> • <a href="command-line-options.html#regard-warnings">‑regard‑warnings</a> • <a href="command-line-options.html#region">‑region</a> • <a href="command-line-options.html#remap">‑remap</a> • <a href="command-line-options.html#remote">‑remote</a> • <a href="command-line-options.html#render">‑render</a> • <a href="command-line-options.html#repage">‑repage</a> • <a href="command-line-options.html#resample">‑resample</a> • <a href="command-line-options.html#resize">‑resize</a> • <a href="command-line-options.html#respect-parentheses">‑respect‑parentheses</a> • <a href="command-line-options.html#reverse">‑reverse</a> • <a href="command-line-options.html#roll">‑roll</a> • <a href="command-line-options.html#rotate">‑rotate</a> • <a href="command-line-options.html#sample">‑sample</a> • <a href="command-line-options.html#sampling-factor">‑sampling‑factor</a> • <a href="command-line-options.html#scale">‑scale</a> • <a href="command-line-options.html#scene">‑scene</a> • <a href="command-line-options.html#screen">‑screen</a> • <a href="command-line-options.html#seed">‑seed</a> • <a href="command-line-options.html#segment">‑segment</a> • <a href="command-line-options.html#selective-blur">‑selective‑blur</a> • <a href="command-line-options.html#separate">‑separate</a> • <a href="command-line-options.html#sepia-tone">‑sepia‑tone</a> • <a href="command-line-options.html#set">‑set</a> • <a href="command-line-options.html#shade">‑shade</a> • <a href="command-line-options.html#shadow">‑shadow</a> • <a href="command-line-options.html#shared-memory">‑shared‑memory</a> • <a href="command-line-options.html#sharpen">‑sharpen</a> • <a href="command-line-options.html#shave">‑shave</a> • <a href="command-line-options.html#shear">‑shear</a> • <a href="command-line-options.html#sigmoidal-contrast">‑sigmoidal‑contrast</a> • <a href="command-line-options.html#silent">‑silent</a> • <a href="command-line-options.html#similarity-threshold">‑similarity‑threshold</a> • <a href="command-line-options.html#size">‑size</a> • <a href="command-line-options.html#sketch">‑sketch</a> • <a href="command-line-options.html#smush">‑smush</a> • <a href="command-line-options.html#snaps">‑snaps</a> • <a href="command-line-options.html#solarize">‑solarize</a> • <a href="command-line-options.html#sparse-color">‑sparse‑color</a> • <a href="command-line-options.html#splice">‑splice</a> • <a href="command-line-options.html#spread">‑spread</a> • <a href="command-line-options.html#statistic">‑statistic</a> • <a href="command-line-options.html#stegano">‑stegano</a> • <a href="command-line-options.html#stereo">‑stereo</a> • <a href="command-line-options.html#storage-type">‑storage‑type</a> • <a href="command-line-options.html#stretch">‑stretch</a> • <a href="command-line-options.html#strip">‑strip</a> • <a href="command-line-options.html#stroke">‑stroke</a> • <a href="command-line-options.html#strokewidth">‑strokewidth</a> • <a href="command-line-options.html#style">‑style</a> • <a href="command-line-options.html#subimage-search">‑subimage‑search</a> • <a href="command-line-options.html#swap">‑swap</a> • <a href="command-line-options.html#swirl">‑swirl</a> • <a href="command-line-options.html#synchronize">‑synchronize</a> • <a href="command-line-options.html#taint">‑taint</a> • <a href="command-line-options.html#text-font">‑text‑font</a> • <a href="command-line-options.html#texture">‑texture</a> • <a href="command-line-options.html#threshold">‑threshold</a> • <a href="command-line-options.html#thumbnail">‑thumbnail</a> • <a href="command-line-options.html#tile">‑tile</a> • <a href="command-line-options.html#tile-offset">‑tile‑offset</a> • <a href="command-line-options.html#tint">‑tint</a> • <a href="command-line-options.html#title">‑title</a> • <a href="command-line-options.html#transform">‑transform</a> • <a href="command-line-options.html#transparent">‑transparent</a> • <a href="command-line-options.html#transparent-color">‑transparent‑color</a> • <a href="command-line-options.html#transpose">‑transpose</a> • <a href="command-line-options.html#transverse">‑transverse</a> • <a href="command-line-options.html#treedepth">‑treedepth</a> • <a href="command-line-options.html#trim">‑trim</a> • <a href="command-line-options.html#type">‑type</a> • <a href="command-line-options.html#undercolor">‑undercolor</a> • <a href="command-line-options.html#unique-colors">‑unique‑colors</a> • <a href="command-line-options.html#units">‑units</a> • <a href="command-line-options.html#unsharp">‑unsharp</a> • <a href="command-line-options.html#update">‑update</a> • <a href="command-line-options.html#verbose">‑verbose</a> • <a href="command-line-options.html#version">‑version</a> • <a href="command-line-options.html#view">‑view</a> • <a href="command-line-options.html#vignette">‑vignette</a> • <a href="command-line-options.html#virtual-pixel">‑virtual‑pixel</a> • <a href="command-line-options.html#visual">‑visual</a> • <a href="command-line-options.html#watermark">‑watermark</a> • <a href="command-line-options.html#wave">‑wave</a> • <a href="command-line-options.html#wavelet-denoise">‑wavelet‑denoise</a> • <a href="command-line-options.html#weight">‑weight</a> • <a href="command-line-options.html#white-point">‑white‑point</a> • <a href="command-line-options.html#white-threshold">‑white‑threshold</a> • <a href="command-line-options.html#window">‑window</a> • <a href="command-line-options.html#window-group">‑window‑group</a> • <a href="command-line-options.html#write">‑write</a> • <a href="command-line-options.html#write-mask">‑write‑mask</a> </p>
85 <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>
87 <div style="margin: auto;">
88 <h3><a class="anchor" id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
91 <p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
93 <p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
96 <div style="margin: auto;">
97 <h3><a class="anchor" id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
100 <p class="magick-description">Resize the image using data-dependent triangulation.</p>
102 <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>
103 option defaults to data-dependent triangulation. Use the <a
104 href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
105 Offsets, if present in the geometry string, are ignored, and the <a
106 href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
108 <div style="margin: auto;">
109 <h3><a class="anchor" id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
112 <p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
114 <p>A Gaussian operator of the given radius and standard deviation
115 (<var>sigma</var>) is used. If <var>sigma</var> is not given it
118 <div style="margin: auto;">
119 <h3><a class="anchor" id="adjoin"></a>-adjoin</h3>
122 <p class="magick-description">Join images into a single multi-image file.</p>
124 <p>This option is enabled by default. An attempt is made to save all images of
125 an image sequence into the given output file. However, some formats, such as
126 JPEG and PNG, do not support more than one image per file, and in that case
127 ImageMagick is forced to write each image as a separate file. As such, if
128 more than one image needs to be written, the filename given is modified by
129 adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
130 make distinct names for each image. </p>
132 <p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
133 separate files, whether or not the file format allows multiple images per file
134 (for example, GIF, MIFF, and TIFF). </p>
136 <p>Including a C-style integer format string in the output filename will
137 automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
138 where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
139 strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
140 who have used the standard <code>printf()</code>' C-library function. As an
141 example, the command</p>
143 <pre class="highlight"><code>convert logo: rose: -morph 15 my%02dmorph.jpg
146 <p>will create a sequence of 17 images (the two given plus 15 more created by
147 <a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
148 my02morph.jpg, ..., my16morph.jpg. </p>
150 <p>In summary, ImageMagick tries to write all images to one file, but will
151 save to multiple files, if any of the following conditions exist...</p>
153 <li>the output image's file format does not allow multi-image files,</li>
154 <li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
155 <li>a printf() integer format string (eg: "%d") is present in the output
160 <div style="margin: auto;">
161 <h3><a class="anchor" id="affine"></a>-affine
162 <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>
165 <p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
167 <p>This option sets a transformation matrix, for use by subsequent <a
168 href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
170 <p>The matrix entries are entered as comma-separated numeric values either in
171 quotes or without spaces. </p>
173 <p>Internally, the transformation matrix has 3x3 elements, but three of them
174 are omitted from the input because they are constant. The new (transformed)
175 coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
176 position (<var>x</var>, <var>y</var>) in the original
177 image are calculated using the following matrix equation.</p>
179 <p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
181 <p> The size of the resulting image is that of the smallest rectangle that
182 contains the transformed source image. The parameters
183 <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
184 subsequently shift the image pixels so that those that are moved out of the
185 image area are cut off.</p>
187 <p>The transformation matrix complies with the left-handed pixel coordinate
188 system: positive <var>x</var> and <var>y</var> directions
189 are rightward and downward, resp.; positive rotation is clockwise.</p>
191 <p> If the translation coefficients <var>t<sub>x</sub></var> and
192 <var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
193 four parameters suffice for rotation and scaling without translation.</p>
195 <p>Scaling by the factors <var>s<sub>x</sub></var> and
196 <var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
197 respectively, is accomplished with the following.</p>
199 <p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
200 href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
204 <pre class="highlight"><code>-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
207 <p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
209 <pre class="highlight"><code>-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
212 <p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
213 <var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
214 = sin(<var>a</var>), and using the following.</p>
216 <pre class="highlight"><code>-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
219 <p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
220 transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
221 >-affine</a> operation using the matrix equal to the product of the matrices
222 of the individual transformations.</p>
224 <p>An attempt is made to detect near-singular transformation matrices. If the
225 matrix determinant has a sufficiently small absolute value it is rejected.</p>
227 <div style="margin: auto;">
228 <h3><a class="anchor" id="alpha"></a>-alpha <var>type</var></h3>
231 <p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
233 <p>Used to set a flag on an image indicating whether or not to use existing alpha
234 channel 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>
237 <dt class="col-md-4">Activate</dt>
238 <dd class="col-md-8">
239 Enable the image's transparency channel. Note normally Set
240 should be used instead of this, unless you specifically need to
241 preserve existing (but specifically turned Off) transparency
244 <dt class="col-md-4">Associate</dt>
245 <dd class="col-md-8">
246 associate the alpha channel with the image.</dd>
248 <dt class="col-md-4">Deactivate</dt>
249 <dd class="col-md-8">
250 Disables the image's transparency channel. Does not delete or change the
251 existing data, just turns off the use of that data.</dd>
253 <dt class="col-md-4">Disassociate</dt>
254 <dd class="col-md-8">
255 disassociate the alpha channel from the image.</dd>
257 <dt class="col-md-4">Set</dt>
258 <dd class="col-md-8">
259 Activates the alpha/matte channel. If it was previously turned off
260 then it also resets the channel to opaque. If the image already had
261 the alpha channel turned on, it will have no effect.</dd>
263 <dt class="col-md-4">Opaque</dt>
264 <dd class="col-md-8">
265 Enables the alpha/matte channel and forces it to be fully opaque.
268 <dt class="col-md-4">Transparent</dt>
269 <dd class="col-md-8">
270 Activates the alpha/matte channel and forces it to be fully
271 transparent. This effectively creates a fully transparent image the
272 same size as the original and with all its original RGB data still
273 intact, but fully transparent. </dd>
275 <dt class="col-md-4">Extract</dt>
276 <dd class="col-md-8">
277 Copies the alpha channel values into all the color channels and turns
278 'Off' the the image's transparency, so as to generate
279 a grayscale mask of the image's shape. The alpha channel data is left
280 intact just deactivated. This is the inverse of 'Copy'.
283 <dt class="col-md-4">Copy</dt>
284 <dd class="col-md-8">
285 Turns 'On' the alpha/matte channel, then copies the
286 grayscale intensity of the image, into the alpha channel, converting
287 a grayscale mask into a transparent shaped mask ready to be colored
288 appropriately. The color channels are not modified. </dd>
290 <dt class="col-md-4">Shape</dt>
291 <dd class="col-md-8">
292 As per 'Copy' but also colors the resulting shape mask with
293 the current background color. That is the RGB color channels is
294 replaced, with appropriate alpha shape.
297 <dt class="col-md-4">Remove</dt>
298 <dd class="col-md-8">
299 Composite the image over the background color.
302 <dt class="col-md-4">Background</dt>
303 <dd class="col-md-8">
304 Set any fully-transparent pixel to the background color, while leaving
305 it fully-transparent. This can make some image file formats, such as
306 PNG, smaller as the RGB values of transparent pixels are more uniform,
307 and thus can compress better.
311 <p>Note that while the obsolete <code>+matte</code> operation was the
312 same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
313 >-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
314 Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
316 <div style="margin: auto;">
317 <h3><a class="anchor" id="annotate"></a>
318 -annotate <var>degrees</var> <var>text</var><br />
319 -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>
322 <p class="magick-description">Annotate an image with text</p>
324 <p>This is a convenience for annotating an image with text. For more precise
325 control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
328 <p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
329 control 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>
331 <p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
332 or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
333 direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
334 convention once it is realized that the positive <var>y</var>–direction is
335 conventionally considered to be <var>downward</var> for images.)</p>
337 <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
340 <p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
342 <p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
343 bottom-left of the text becomes the upper-left corner of the image, which is
344 probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
345 case leads to nice results.</p>
347 <p>Text is any UTF-8 encoded character sequence. If <var>text</var>
348 is of the form '@mytext.txt', the text is read from the file
349 <code>mytext.txt</code>. Text in a file is taken literally; no embedded
350 formatting characters are recognized.</p>
352 <div style="margin: auto;">
353 <h3><a class="anchor" id="antialias"></a>-antialias</h3>
356 <p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
358 <p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
359 drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
360 antialiasing edge pixels. This will then reduce the number of colors added to
361 an image to just the colors being directly drawn. That is, no mixed colors
362 are added when drawing such objects. </p>
364 <div style="margin: auto;">
365 <h3><a class="anchor" id="append"></a>-append</h3>
368 <p class="magick-description">Join current images vertically or horizontally.</p>
370 <p>This option creates a single longer image, by joining all the current
371 images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
372 stack images left-to-right. </p>
374 <p>If they are not of the same width, narrower images are padded with the
375 current <a href="command-line-options.html#background">-background</a> color setting, and their
376 position relative to each other can be controlled by the current <a
377 href="command-line-options.html#gravity">-gravity</a> setting. </p>
380 <div style="margin: auto;">
381 <h3><a class="anchor" id="attenuate"></a>-attenuate <var>value</var></h3>
384 <p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
386 <p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
388 <div style="margin: auto;">
389 <h3><a class="anchor" id="authenticate"></a>-authenticate <var>password</var></h3>
392 <p class="magick-description">Decrypt a PDF with a password.</p>
394 <p>Use this option to supply a <var>password</var> for decrypting
395 a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
396 encrypting using the MSC API is not supported.</p>
398 <p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
399 and <a href="command-line-options.html#decipher">-decipher</a>. </p>
402 <div style="margin: auto;">
403 <h3><a class="anchor" id="auto-gamma"></a>-auto-gamma</h3>
406 <p class="magick-description">Automagically adjust gamma level of image.</p>
408 <p>This calculates the mean values of an image, then applies a calculated <a
409 href="command-line-options.html#gamma" >-gamma</a> adjustment so that the mean color in the
410 image will get a value of 50%. </p>
412 <p>This means that any solid 'gray' image becomes 50% gray. </p>
414 <p>This works well for real-life images with little or no extreme dark and
415 light areas, but tend to fail for images with large amounts of bright sky or
416 dark shadows. It also does not work well for diagrams or cartoon like images.
419 <p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
420 '<var>sync</var>' flag for channel synchronization), to determine which color
421 values is used and modified. As the default <a href="command-line-options.html#channel"
422 >-channel</a> setting is '<var>RGB,sync</var>', channels are modified
423 together by the same gamma value, preserving colors. </p>
427 <div style="margin: auto;">
428 <h3><a class="anchor" id="auto-level"></a>-auto-level</h3>
431 <p class="magick-description">Automagically adjust color levels of image.</p>
433 <p>This is a 'perfect' image normalization operator. It finds the exact
434 minimum and maximum color values in the image and then applies a <a
435 href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
438 <p>The operator is not typically used for real-life images, image scans, or
439 JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
440 for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
441 right operator to use for color stretching gradient images being used to
442 generate Color lookup tables, distortion maps, or other 'mathematically'
445 <p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
446 href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
447 >-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
448 problems that these operators may have. That is <a href="command-line-options.html#auto-level"
449 >-auto-level</a> is the perfect or ideal version these operators. </p>
451 <p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
452 special '<var>sync</var>' flag for channel synchronization), to determine
453 which color values are used and modified. As the default <a
454 href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
455 '<var>sync</var>' ensures that the color channels will are modified
456 together by the same gamma value, preserving colors, and ignoring
460 <div style="margin: auto;">
461 <h3><a class="anchor" id="auto-orient"></a>-auto-orient</h3>
464 <p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
466 <p>This operator reads and resets the EXIF image profile setting 'Orientation'
467 and then performs the appropriate 90 degree rotation on the image to orient
468 the image, for correct viewing. </p>
470 <p>This EXIF profile setting is usually set using a gravity sensor in digital
471 camera, however photos taken directly downward or upward may not have an
472 appropriate value. Also images that have been orientation 'corrected' without
473 reseting this setting, may be 'corrected' again resulting in a incorrect
474 result. If the EXIF profile was previously stripped, the <a
475 href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
477 <div style="margin: auto;">
478 <h3><a class="anchor" id="auto-threshold"></a>-auto-threshold <var>method</var></h3>
481 <p class="magick-description">automatically perform image thresholding.</p>
483 <p>Here are the valid methods:</p>
486 <dt class="col-md-4">Undefined</dt><dd class="col-md-8">0: No method specified (equivalent to '<code>OTSU</code>').</dd>
487 <dt class="col-md-4">Kapur</dt><dd class="col-md-8">maximum entropy thresholding.</dd>
488 <dt class="col-md-4">OTSU</dt><dd class="col-md-8">cluster-based image thresholding.</dd>
489 <dt class="col-md-4">Triangle</dt><dd class="col-md-8">a geometric thresholding method.</dd>
492 <p>The computed threshold is returned as the <kbd>auto-threshold:threshold</kbd> image property.</p>
494 <div style="margin: auto;">
495 <h3><a class="anchor" id="average"></a>-average</h3>
498 <p class="magick-description">Average a set of images.</p>
500 <p>An error results if the images are not identically sized.</p>
503 <div style="margin: auto;">
504 <h3><a class="anchor" id="backdrop"></a>-backdrop</h3>
507 <p class="magick-description">Display the image centered on a backdrop.</p>
509 <p>This backdrop covers the entire workstation screen and is useful for hiding
510 other X window activity while viewing the image. The color of the backdrop is
511 specified as the background color. The color is specified using the format
512 described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
514 <div style="margin: auto;">
515 <h3><a class="anchor" id="background"></a>-background <var>color</var></h3>
518 <p class="magick-description">Set the background color.</p>
520 <p>The color is specified using the format described under the <a
521 href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
522 specified or found in the image) is white.</p>
524 <div style="margin: auto;">
525 <h3><a class="anchor" id="bench"></a>-bench <var>iterations</var></h3>
528 <p class="magick-description">Measure performance.</p>
530 <p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
531 consider the following command and its output. Modify the benchmark with the
532 -duration to run the benchmark for a fixed number of seconds and -concurrent
533 to run the benchmark in parallel (requires the OpenMP feature).</p>
535 <pre class="highlight"><code>-> convert logo: -resize 200% -bench 5 logo.png
536 Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
537 Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
538 Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
539 Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
540 Performance[4]: 5i 0.875657ips 6.880u 0:05.710
543 <p>In this example, 5 iterations were completed at 2.174 iterations per
544 second, using 3 threads and 3.190 seconds of the user allotted time, for
545 a total elapsed time of 2.300 seconds.</p>
547 <div style="margin: auto;">
548 <h3><a class="anchor" id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
551 <p class="magick-description">Add bias when convolving an image.</p>
553 <p>This option shifts the output of <a href="command-line-options.html#convolve">‑convolve</a> so that
554 positive and negative results are relative to the specified bias value. </p>
556 <p>This is important for non-HDRI compilations of ImageMagick when dealing
557 with convolutions that contain negative as well as positive values. This is
558 especially the case with convolutions involving high pass filters or edge
559 detection. Without an output bias, the negative values are clipped at
562 <p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">‑bias</a> is not needed, as ImageMagick is able to store/handle any
563 negative results without clipping to the color value range
564 (0..QuantumRange).</p>
566 <p>See the discussion on HDRI implementations of ImageMagick on the page <a
567 href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
568 about HDRI go the ImageMagick <a
569 href="../Usage/basics/#hdri" >Usage</a> pages or this
571 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
574 <div style="margin: auto;">
575 <h3><a class="anchor" id="black-point-compensation"></a>-black-point-compensation</h3>
578 <p class="magick-description">Use black point compensation.</p>
580 <div style="margin: auto;">
581 <h3><a class="anchor" id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
584 <p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
586 <p> The threshold value can be given as a percentage or as an absolute integer
587 value within [0, <var>QuantumRange</var>] corresponding to the
588 desired <a href="command-line-options.html#channel">‑channel</a> value. See <a href="command-line-options.html#threshold">‑threshold</a>for more details on thresholds and resulting values. </p>
591 <div style="margin: auto;">
592 <h3><a class="anchor" id="blend"></a>-blend <var>geometry</var></h3>
595 <p class="magick-description">blend an image into another by the given absolute value or percent.</p>
597 <p>Blend will average the images together ('plus') according to the
598 percentages given and each pixels transparency. If only a single percentage
599 value is given it sets the weight of the composite or 'source' image, while
600 the background image is weighted by the exact opposite amount. That is a
601 <code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
602 'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
605 <div style="margin: auto;">
606 <h3><a class="anchor" id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
609 <p class="magick-description">Set the blue chromaticity primary point.</p>
611 <div style="margin: auto;">
612 <h3><a class="anchor" id="blue-shift"></a>-blue-shift <var>factor</var></h3>
615 <p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
617 <div style="margin: auto;">
619 <div style="margin: auto;">
620 <h3><a class="anchor" id="blur"></a>-blur <var>radius</var><br />-blur <var>radius</var>x<var>sigma</var></h3>
623 <p class="magick-description">Reduce image noise and reduce detail levels.</p>
625 <p>Convolve the image with a Gaussian or normal distribution using the given
626 <var >Sigma</var> value. The formula is:</p>
628 <p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/></p>
630 <p>The <var >Sigma</var> value is the important argument, and
631 determines the actual amount of blurring that will take place. </p>
633 <p>The <var >Radius</var> is only used to determine the size of the
634 array which will hold the calculated Gaussian distribution. It should be an
635 integer. If not given, or set to zero, IM will calculate the largest possible
636 radius that will provide meaningful results for the Gaussian distribution.
639 <p>The larger the <var >Radius</var> the slower the
640 operation is. However too small a <var >Radius</var>, and severe
641 aliasing effects may result. As a guideline, <var >Radius</var>
642 should be at least twice the <var >Sigma</var> value, though three
643 times will produce a more accurate result. </p>
645 <p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
646 by taking advantage of the separability properties of the distribution. Here
647 we apply a single-dimensional Gaussian matrix in the horizontal direction,
648 then repeat the process in the vertical direction.</p>
650 <p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
651 pixels which are outside the image proper are blurred into the final result.
655 <div style="margin: auto;">
656 <h3><a class="anchor" id="border"></a>-border <var>geometry</var></h3>
659 <p class="magick-description">Surround the image with a border of color. </p>
661 <p>Set the width and height using the <var>size</var> portion of the
662 <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
665 <p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
668 <dt class="col-md-4"><var>value</var></dt>
669 <dd class="col-md-8">value is added to both left/right and top/bottom</dd>
670 <dt class="col-md-4"><var>value-x</var><code>x</code></dt>
671 <dd class="col-md-8">value-x is added only to left/right and top/bottom are unchanged</dd>
672 <dt class="col-md-4"><code>x</code><var>value-y</var></dt>
673 <dd class="col-md-8">value-y is added only to top/bottom and left/right are unchanged</dd>
674 <dt class="col-md-4"><var>value-x</var><code>x</code><var>value-y</var></dt>
675 <dd class="col-md-8">value-x is added to left/right and value-y added to top/bottom</dd>
676 <dt class="col-md-4"><var>value-x</var><code>x</code>0</dt>
677 <dd class="col-md-8">value-x is added only to left/right and top/bottom are unchanged</dd>
678 <dt class="col-md-4">0<code>x</code><var>value-y</var></dt>
679 <dd class="col-md-8">value-y is added only to top/bottom and left/right are unchanged</dd>
680 <dt class="col-md-4"><var>value</var>%</dt>
681 <dd class="col-md-8">value % of width is added to left/right and value % of height is added to top/bottom</dd>
682 <dt class="col-md-4"><var>value-x</var><code>x</code>%</dt>
683 <dd class="col-md-8">value-x % of width is added to left/right and to top/bottom</dd>
684 <dt class="col-md-4">x<var>value-y</var>%</dt>
685 <dd class="col-md-8">value-y % of height is added to top/bottom and to left/right</dd>
686 <dt class="col-md-4"><var>value-x</var>%<code>x</code><var>value-y</var>%</dt>
687 <dd class="col-md-8">value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
688 <dt class="col-md-4"><var>value-x</var>%<code>x</code>0%</dt>
689 <dd class="col-md-8">value-x % of width is added to left/right and top/bottom are unchanged</dd>
690 <dt class="col-md-4">0%<code>x</code><var>value-y</var>%</dt>
691 <dd class="col-md-8">value-y % of height is added to top/bottom and left/right are unchanged</dd>
694 <p>Set the border color by preceding with the <a
695 href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
697 <p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
698 href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
699 '<code>Over</code>' composition method. It generates an image of the appropriate
700 size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
701 overlaying the original image in the center of this net image. This means that
702 with the default compose method of '<code>Over</code>' any transparent parts may
703 be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
704 <p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
707 <div style="margin: auto;">
708 <h3><a class="anchor" id="bordercolor"></a>-bordercolor <var>color</var></h3>
711 <p class="magick-description">Set the border color.</p>
713 <p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
715 <p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
717 <div style="margin: auto;">
718 <h3><a class="anchor" id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
721 <p class="magick-description">Set the border width.</p>
723 <div style="margin: auto;">
724 <h3><a class="anchor" id="brightness-contrast"></a>-brightness-contrast <var>brightness</var><br />-brightness-contrast <var>brightness</var>{x<var>contrast</var>}{<var>%</var>}</h3>
727 <p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
729 <p>Brightness and Contrast values apply changes to the input image. They are
730 not absolute settings. A brightness or contrast value of zero means no change.
731 The range of values is -100 to +100 on each. Positive values increase the
732 brightness or contrast and negative values decrease the brightness or contrast.
733 To control only contrast, set the brightness=0. To control only brightness,
734 set contrast=0 or just leave it off.</p>
736 <p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
737 apply the brightness and/or contrast change. The default is to apply the same
738 transformation to all channels.</p>
740 <p>Brightness and Contrast arguments are converted to offset and slope of a
741 linear transform and applied
742 using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
744 <p>The slope varies from 0 at contrast=-100 to almost vertical at
745 contrast=+100. For brightness=0 and contrast=-100, the result are totally
746 midgray. For brightness=0 and contrast=+100, the result will approach but
747 not quite reach a threshold at midgray; that is the linear transformation
748 is a very steep vertical line at mid gray.</p>
750 <p>Negative slopes, i.e. negating the image, are not possible with this
751 function. All achievable slopes are zero or positive.</p>
753 <p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
754 at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
755 totally white. Similarly, when contrast=0 and brightness=-100, the result is
758 <p>As the range of values for the arguments are -100 to +100, adding the '%'
759 symbol is no different than leaving it off.</p>
761 <div style="margin: auto;">
762 <h3><a class="anchor" id="cache"></a>-cache <var>threshold</var></h3>
765 <p class="magick-description">(This option has been replaced by the <a href='command-line-options.html#limit'>-limit</a> option).</p>
767 <div style="margin: auto;">
768 <h3><a class="anchor" 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>
771 <p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
773 <p>The thresholds range from 0 to 100% (e.g. -canny 0x1+10%+30%) with {<var>+lower-percent</var>} < {<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>
775 <div style="margin: auto;">
776 <h3><a class="anchor" id="caption"></a>-caption <var>string</var></h3>
779 <p class="magick-description">Assign a caption to an image.</p>
781 <p>This option sets the caption meta-data of an image read in after this
782 option has been given. To modify a caption of images already in memory use
783 "<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
785 <p>The caption can contain special format characters listed in the <a
786 href="escape.html">Format and
787 Print Image Properties</a>. These attributes are expanded when the caption
788 is finally assigned to the individual images. </p>
790 <p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
791 remaining characters in the string. Comments read in from a file are literal;
792 no embedded formatting characters are recognized.</p>
794 <p>Caption meta-data is not visible on the image itself. To do that use the
795 <a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
800 <pre class="highlight"><code>-caption "%m:%f %wx%h" bird.miff
803 <p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
804 that the image <code>bird.miff</code> has a width of 512 and a height of
808 <div style="margin: auto;">
809 <h3><a class="anchor" id="cdl"></a>-cdl <var>filename</var></h3>
812 <p class="magick-description">color correct with a color decision list.</p>
814 <p>Here is an example color correction collection:</p>
816 <pre class="highlight"><code><?xml version="1.0" encoding="UTF-8"?>
817 <ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
818 <ColorCorrection id="cc06668">
820 <Slope> 0.9 1.2 0.5 </Slope>
821 <Offset> 0.4 -0.5 0.6 </Offset>
822 <Power> 1.0 0.8 1.5 </Power>
825 <Saturation> 0.85 </Saturation>
827 </ColorCorrection>
828 </ColorCorrectionCollection>
831 <div style="margin: auto;">
832 <h3><a class="anchor" id="channel"></a>-channel <var>type</var></h3>
835 <p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
837 <p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
838 <code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
839 <code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
840 <code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
841 <code>CMYKA</code>.</p>
843 <p>The channels above can also be specified as a comma-separated list or can be
844 abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
845 '<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
846 '<code>M</code>', '<code>Y</code>', '<code>K</code>'.</p>
848 <p>The numerals 0 to 31 may also be used to specify channels, where 0 to 5 are: <br />
849 '<code>0</code>' equals <code>Red</code> or <code>Cyan</code> <br />
850 '<code>1</code>' equals <code>Green</code> or <code>Magenta</code> <br />
851 '<code>2</code>' equals <code>Blue</code> or <code>Yellow</code> <br />
852 '<code>3</code>' equals <code>Black</code> <br />
853 '<code>4</code>' equals <code>Alpha</code> or <code>Opacity</code> <br />
854 '<code>5</code>' equals <code>Index</code></p>
856 <p>For example, to only select the <code>Red</code> and <code>Blue</code> channels
857 you can use any of the following:</p>
858 <pre class="highlight">
859 <code>-channel Red,Blue</code>
860 <code>-channel R,B</code>
861 <code>-channel RB</code>
862 <code>-channel 0,2</code>
865 <p>All the channels that are present in an image can be specified using the
866 special channel type <code>All</code>. Not all operators are 'channel capable',
867 but generally any operators that are generally 'grey-scale' image operators,
868 will understand this setting. See individual operator documentation. </p>
872 <p>On top of the normal channel selection an extra flag can be specified,
873 '<code>Sync</code>'. This is turned on by default and if set means that
874 operators that understand this flag should perform: cross-channel
875 synchronization of the channels. If not specified, then most grey-scale
876 operators will apply their image processing operations to each individual
877 channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
878 setting) completely independently from each other. </p>
880 <p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
881 <a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
882 together in exactly the same way so that colors will remain in-sync. Without
883 it being set, then each channel is modified separately and
884 independently, which may produce color distortion. </p>
886 <p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
887 and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
888 the '<code>Sync</code>' flag to modify the behavior of pixel colors according
889 to the alpha channel (if present). That is to say it will modify the image
890 processing with the understanding that fully-transparent colors should not
891 contribute to the final result. </p>
893 <p>Basically, by default, operators work with color channels in synchronous, and
894 treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
895 setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
896 How each operator does this depends on that operators current implementation.
897 Not all operators understands this flag at this time, but that is changing.
900 <p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
903 <p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
904 '<code>RGBK,sync</code>', which specifies that operators act on all color
905 channels except the transparency channel, and that all the color channels are
906 to be modified in exactly the same way, with an understanding of transparency
907 (depending on the operation being applied). The 'plus' form <a
908 href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
910 <p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
911 include the following.
913 <a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
914 <a href="command-line-options.html#auto-level">-auto-level</a>,
915 <a href="command-line-options.html#black-threshold">-black-threshold</a>,
916 <a href="command-line-options.html#blur">-blur</a>,
917 <a href="command-line-options.html#clamp">-clamp</a>,
918 <a href="command-line-options.html#clut">-clut</a>,
919 <a href="command-line-options.html#combine">-combine</a>,
920 <a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
921 <a href="command-line-options.html#convolve">-convolve</a>,
922 <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
923 <a href="command-line-options.html#evaluate">-evaluate</a>,
924 <a href="command-line-options.html#function">-function</a>,
925 <a href="command-line-options.html#fx">-fx</a>,
926 <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
927 <a href="command-line-options.html#hald-clut">-hald-clut</a>,
928 <a href="command-line-options.html#motion-blur">-motion-blur</a>,
929 <a href="command-line-options.html#morphology">-morphology</a>,
930 <a href="command-line-options.html#negate">-negate</a>,
931 <a href="command-line-options.html#normalize">-normalize</a>,
932 <a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
933 <a href="command-line-options.html#radial-blur">-radial-blur</a>,
934 <a href="command-line-options.html#random-threshold">-random-threshold</a>,
935 <a href="command-line-options.html#separate">-separate</a>,
936 <a href="command-line-options.html#threshold">-threshold</a>, and
937 <a href="command-line-options.html#white-threshold">-white-threshold</a>.
940 <p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
941 >+channel</a> default setting is in effect, verses ANY user defined <a
942 href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
943 default). These operators have yet to be made to understand the newer 'Sync'
946 <p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
947 the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
948 has been defined. This is not 'Sync flag controlled, yet. </p>
950 <p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
951 href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
952 color channels if the '<code>alpha</code>' channel is also enabled by <a
953 href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
954 fully-transparent colors are treated as being fully-transparent, and thus any
955 underlying 'hidden' color has no effect on the final results. Typically
956 resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
957 convolution equivalents however does have a understanding of the 'Sync' flag
958 and will thus handle transparency correctly by default. </p>
960 <p>As a alpha channel is optional within images, some operators will read the
961 color channels of an image as a greyscale alpha mask, when the image has no
962 alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
963 the operator to apply the operation using alpha channels. The <a
964 href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
966 <div style="margin: auto;">
967 <h3><a class="anchor" id="channel-fx"></a>-channel-fx <var>expression</var></h3>
970 <p class="magick-description">exchange, extract, or copy one or more image channels.</p>
972 <p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red or 0, green or 1, etc.), separated by certain operation symbols as follows:</p>
974 <pre class="highlight"><code><=> exchange two channels (e.g. red<=>blue)
975 => copy one channel to another channel (e.g. red=>green)
976 = assign a constant value to a channel (e.g. red=50%)
977 , write new image with channels in the specified order (e.g. red, green)
978 ; add a new output image for the next set of channel operations (e.g. red; green; blue)
979 | move to the next input image for the source of channel data (e.g. | gray=>alpha)
982 <p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
984 <pre class="highlight"><code>-channel-fx "red; green; blue"
987 <p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
989 <p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
990 <pre class="highlight"><code>convert wizard.png mask.pgm -channel-fx '| gray=>alpha' wizard-alpha.png
992 <p>Use a similar command to define a read mask:</p>
993 <pre class="highlight"><code>convert wizard.png mask.pgm -channel-fx '| gray=>read-mask' wizard-mask.png
996 <p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
998 <div style="margin: auto;">
999 <h3><a class="anchor" id="charcoal"></a>-charcoal <var>factor</var></h3>
1002 <p class="magick-description">Simulate a charcoal drawing.</p>
1005 <div style="margin: auto;">
1006 <h3><a class="anchor" id="chop"></a>-chop <var>geometry</var></h3>
1009 <p class="magick-description">Remove pixels from the interior of an image.</p>
1011 <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>
1012 and <var>height</var> given in the of the <var>size</var>
1013 portion of the <var>geometry</var> argument give the number of
1014 columns and rows to remove. The <var>offset</var> portion of
1015 the <var>geometry</var> argument is influenced by
1016 a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
1018 <p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
1019 and moves the remaining corner blocks leftward and upward to close the gaps.</p>
1021 <p>While it can remove internal rows and columns of pixels, it is more
1022 typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
1023 offsets so as to remove a single edge from an image. Compare this to <a
1024 href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
1025 sides of the image. </p>
1027 <p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
1028 href="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>
1030 <div style="margin: auto;">
1031 <h3><a class="anchor" id="clamp"></a>-clamp</h3>
1034 <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>
1036 <div style="margin: auto;">
1037 <h3><a class="anchor" id="clip"></a>-clip</h3>
1040 <p class="magick-description">Apply the clipping path if one is present.</p>
1042 <p>If a clipping path is present, it is applied to subsequent operations.</p>
1044 <p>For example, in the command</p>
1046 <pre class="highlight"><code>convert cockatoo.tif -clip -negate negated.tif
1049 <p>only the pixels within the clipping path are negated.</p>
1051 <p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
1052 delegate library is not present, the option is ignored.</p>
1054 <p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1056 <div style="margin: auto;">
1057 <h3><a class="anchor" id="clip-mask"></a>-clip-mask</h3>
1060 <p class="magick-description">Clip the image as defined by this mask.</p>
1062 <p>Use the alpha channel of the current image as a mask. Any areas that is
1063 white is not modified by any of the 'image processing operators' that follow,
1064 until the mask is removed. Pixels in the black areas of the clip mask are
1065 modified per the requirements of the operator. </p>
1067 <p>In some ways this is similar to (though not the same) as defining
1068 a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1069 mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
1072 <p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1074 <div style="margin: auto;">
1075 <h3><a class="anchor" id="clip-path"></a>-clip-path <var>id</var></h3>
1078 <p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1080 <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>
1082 <p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1084 <div style="margin: auto;">
1085 <h3><a class="anchor" id="clone"></a>-clone <var>index(s)</var></h3>
1088 <p class="magick-description">make a clone of an image (or images).</p>
1090 <p>Inside parenthesis (where the operator is normally used) it will make a
1091 clone of the images from the last 'pushed' image sequence, and adds them to
1092 the end of the current image sequence. Outside parenthesis
1093 (not recommended) it clones the images from the current image sequence. </p>
1095 <p>Specify the image by its index in the sequence. The first image is index
1096 0. Negative indexes are relative to the end of the sequence; for
1097 example, <code>−1</code>
1098 represents the last image of the sequence. Specify a range of images with a
1099 dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1100 spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1101 effectively clone all the images. </p>
1103 <p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1104 in the image sequence, and is thus equivalent to using a argument of
1105 '<code>−1</code>'. </p>
1107 <div style="margin: auto;">
1108 <h3><a class="anchor" id="clut"></a>-clut</h3>
1111 <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>
1113 <p>The second (LUT) image is ordinarily a gradient image containing the
1114 histogram mapping of how each channel should be modified. Typically it is a
1115 either a single row or column image of replacement color values. If larger
1116 than a single row or column, values are taken from a diagonal line from
1117 top-left to bottom-right corners.</p>
1119 <p>The lookup is further controlled by the <a
1120 href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
1121 LUT which is not the full length needed by the ImageMagick installed Quality
1122 (Q) level. Good settings for this are the '<code>bilinear</code>' and
1123 '<code>bicubic</code>' interpolation settings, which give smooth color
1124 gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1125 lookup of color values. </p>
1127 <p>This operator is especially suited to replacing a grayscale image with a
1128 specific color gradient from the CLUT image. </p>
1130 <p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
1131 setting will have their values replaced. In particular, since the default <a
1132 href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1133 transparency (alpha/matte channel) is not affected, unless the <a
1134 href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1135 set, it is treated by the <a href="command-line-options.html#clut" >-clut</a> operator in the same way
1136 as the other channels, implying that alpha/matte values are replaced using the
1137 alpha/matte values of the original image. </p>
1139 <p>If either the image being modified, or the lookup image, contains no
1140 transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1141 href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
1142 assumed that image represents a grayscale gradient which is used for the
1143 replacement alpha values. That is you can use a grayscale CLUT image to
1144 adjust a existing images alpha channel, or you can color a grayscale image
1145 using colors form CLUT containing the desired colors, including transparency.
1148 <p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
1149 according to the lookup of the full color RGB value from a 2D representation
1150 of a 3D color cube. </p>
1153 <div style="margin: auto;">
1154 <h3><a class="anchor" id="coalesce"></a>-coalesce</h3>
1157 <p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1159 <p>Overlay each image in an image sequence according to
1160 its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1161 an animation at each point in the animation sequence. All images should be
1162 the same size, and are assigned appropriate GIF disposal settings for the
1163 animation to continue working as expected as a GIF animation. Such frames
1164 are more easily viewed and processed than the highly optimized GIF overlay
1167 <p>The animation can be re-optimized after processing using
1168 the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1169 there is no guarantee that the restored GIF animation optimization is
1170 better than the original. </p>
1173 <div style="margin: auto;">
1174 <h3><a class="anchor" id="colorize"></a>-colorize <var>value</var></h3>
1177 <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>
1179 <p>Specify the amount of colorization as a percentage. Separate colorization
1180 values can be applied to the red, green, and blue channels of the image with
1181 a comma-delimited list of colorization
1182 values (e.g., <code>-colorize 0,0,50</code>).</p>
1184 <div style="margin: auto;">
1185 <h3><a class="anchor" id="colormap"></a>-colormap <var>type</var></h3>
1188 <p class="magick-description">Define the colormap type.</p>
1190 <p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1192 <p>This option only applies when the default X server visual
1193 is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1194 to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1195 a shared colormap is allocated. The image shares colors with
1196 other X clients. Some image colors could be approximated,
1197 therefore your image may look very different than intended.
1198 If <code>private</code> is chosen, the image colors appear exactly
1199 as they are defined. However, other clients may go <var>technicolor</var>
1200 when the image colormap is installed.</p>
1202 <div style="margin: auto;">
1203 <h3><a class="anchor" id="colors"></a>-colors <var>value</var></h3>
1206 <p class="magick-description">Set the preferred number of colors in the image.</p>
1208 <p>The actual number of colors in the image may be less than your request,
1209 but never more. Note that this a color reduction option. Images with fewer
1210 unique colors than specified by <var>value</var> will have any
1211 duplicate or unused colors removed. The ordering of an existing color
1212 palette may be altered. When converting an image from color to grayscale,
1213 it is more efficient to convert the image to the gray colorspace before
1214 reducing the number of colors. Refer to
1215 the <a href="../www/quantize.html">
1216 color reduction algorithm</a> for more details.</p>
1218 <div style="margin: auto;">
1219 <h3><a class="anchor" id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1222 <p class="magick-description">apply color correction to the image.</p>
1224 <p>This option permits saturation changes, hue rotation, luminance to alpha,
1225 and various other effects. Although variable-sized transformation matrices
1226 can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1227 for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1228 Adobe Flash except offsets are in column 6 rather than 5 (in support of
1229 CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1231 <p>As an example, to add contrast to an image with offsets, try this command:</p>
1233 <pre class="highlight"><code>convert kittens.jpg -color-matrix \
1234 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1235 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1236 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1237 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1238 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1239 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1241 <div style="margin: auto;">
1242 <h3><a class="anchor" id="colorspace"></a>-colorspace <var>value</var></h3>
1245 <p class="magick-description">Set the image colorspace.</p>
1249 <pre class="highlight"><code>CMY CMYK Gray HCL
1253 OHTA Rec601YCbCr Rec709YCbCr RGB
1254 scRGB sRGB Transparent xyY
1256 YIQ YPbPr YUV Undefined
1259 <p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1261 <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>
1263 <table class="table table-sm table-striped">
1264 <caption>Conversion of RGB to Other Color Spaces</caption>
1265 <tr><th valign="middle">CMY</th></tr>
1266 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1267 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1268 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1269 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1270 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1271 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1272 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1273 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1275 <tr><th valign="middle">Gray</th></tr>
1276 <tr><td valign="middle">Gray = 0.212656*R+0.715158*G+0.072186*B</td></tr>
1278 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1279 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1280 <tr><td valign="middle">S=distance from axis outward</td></tr>
1281 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1283 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1284 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1285 <tr><td valign="middle">S=distance from axis outward</td></tr>
1286 <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>
1288 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1289 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1290 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1291 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1293 <tr><th valign="middle">LAB</th></tr>
1294 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1295 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1296 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1297 <tr><th valign="middle">LinearGray</th></tr>
1298 <tr><td valign="middle">LinearGray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1300 <tr><th valign="middle">LOG</th></tr>
1301 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1302 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1303 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1305 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1306 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1307 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1308 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1310 <tr><th valign="middle">Rec601Luma</th></tr>
1311 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1313 <tr><th valign="middle">Rec601YCbCr</th></tr>
1314 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1315 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1316 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1318 <tr><th valign="middle">Rec709Luma</th></tr>
1319 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1321 <tr><th valign="middle">Rec709YCbCr</th></tr>
1322 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1323 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1324 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1325 <tr><th valign="middle">sRGB</th></tr>
1326 <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>
1327 <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>
1328 <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>
1330 <tr><th valign="middle">XYZ</th></tr>
1331 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1332 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1333 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1335 <tr><th valign="middle">YCC</th></tr>
1336 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1337 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1338 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1340 <tr><th valign="middle">YCbCr</th></tr>
1341 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1342 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1343 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1345 <tr><th valign="middle">YIQ</th></tr>
1346 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1347 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1348 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1350 <tr><th valign="middle">YPbPr</th></tr>
1351 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1352 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1353 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1355 <tr><th valign="middle">YUV</th></tr>
1356 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1357 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1358 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1361 <p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1363 <p>Use the <code>Undefined</code> colorspace to identify multi-spectral images.</p>
1365 <div style="margin: auto;">
1366 <h3><a class="anchor" id="combine"></a>-combine</h3>
1367 <h3>+combine <var>colorspace</var></h3>
1370 <p class="magick-description">Combine one or more images into a single image.</p>
1372 <p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1373 combined image are taken from the grayscale values of each image in the
1374 sequence, in order. For the default -channel setting of <code>RGB</code>, this
1375 means the first image is assigned to the <code>Red</code> channel, the second
1376 to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1378 <p>This option can be thought of as the inverse to <a
1379 href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
1380 Thus, in the following example, the final image should be a copy of the
1383 <pre class="highlight"><code>convert original.png -channel RGB -separate sepimage.png
1384 convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1385 -combine imagecopy.png
1388 <div style="margin: auto;">
1389 <h3><a class="anchor" id="comment"></a>-comment <var>string</var></h3>
1392 <p class="magick-description">Embed a comment in an image.</p>
1394 <p>This option sets the comment meta-data of an image read in after this
1395 option has been given. To modify a comment of images already in memory use
1396 "<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1398 <p>The comment can contain special format characters listed in the <a
1399 href="escape.html">Format and
1400 Print Image Properties</a>. These attributes are expanded when the comment
1401 is finally assigned to the individual images. </p>
1403 <p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1404 remaining characters in the string. Comments read in from a file are literal;
1405 no embedded formatting characters are recognized.</p>
1407 <p>Comment meta-data are not visible on the image itself. To do that use the
1408 <a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1413 <pre class="highlight"><code>-comment "%m:%f %wx%h" bird.miff
1416 <p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1417 that the image <code>bird.miff</code> has a width of 512 and a height of
1420 <div style="margin: auto;">
1421 <h3><a class="anchor" id="compare"></a>-compare</h3>
1424 <p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1426 <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>
1428 <pre class="highlight"><code>convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
1431 <p>To get the metric value use the string format "%[distortion]".</p>
1433 <pre class="highlight"><code>convert image.png reference.png -metric RMSE -compare -format \
1434 "%[distortion]" info:
1437 <div style="margin: auto;">
1438 <h3><a class="anchor" id="complex"></a>-complex <var>operator</var></h3>
1441 <p class="magick-description">perform complex mathematics on an image sequence</p>
1443 Choose from these operators:
1445 <pre class="highlight"><code>add
1454 <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>
1456 <div style="margin: auto;">
1457 <h3><a class="anchor" id="compose"></a>-compose <var>operator</var></h3>
1460 <p class="magick-description">Set the type of image composition.</p>
1462 <p>See <a href="../www/compose.html">Alpha Compositing</a> for
1463 a detailed discussion of alpha compositing.</p>
1465 <p>This setting affects image processing operators that merge two (or more)
1466 images together in some way. This includes the operators,
1467 <a href="command-line-options.html#composite">-compare</a>,
1468 <a href="command-line-options.html#composite">-composite</a>,
1469 <a href="command-line-options.html#layers">-layers</a> composite,
1470 <a href="command-line-options.html#flatten">-flatten</a>,
1471 <a href="command-line-options.html#mosaic">-mosaic</a>,
1472 <a href="command-line-options.html#layers">-layers</a> merge,
1473 <a href="command-line-options.html#border">-border</a>,
1474 <a href="command-line-options.html#frame">-frame</a>,
1475 and <a href="command-line-options.html#extent">-extent</a>. </p>
1477 <p>It is also one of the primary options for the "<code>composite</code>"
1481 <div style="margin: auto;">
1482 <h3><a class="anchor" id="composite"></a>-composite</h3>
1485 <p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1487 <p>Take the first image 'destination' and overlay the second 'source' image
1488 according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
1489 of the 'source' or 'overlay' image is controlled according to <a
1490 href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
1493 <p>If a third image is given this is treated as a grayscale blending 'mask' image
1494 relative to the first 'destination' image. This mask is blended with the
1495 source image. However for the '<code>displace</code>' compose method, the
1496 mask is used to provide a separate Y-displacement image instead. </p>
1498 <p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
1499 arguments or flags these can be provided by setting the <a
1500 href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
1501 appropriately for the compose method. </p>
1503 <p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
1504 image outside the overlay area. You can disable this by setting the special <a
1505 href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
1506 to '<code>false</code>'. </p>
1508 <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>
1511 <div style="margin: auto;">
1512 <h3><a class="anchor" id="compress"></a>-compress <var>type</var></h3>
1515 <p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1517 <p>Choices are: <code>None</code>, <code>BZip</code>, <code
1518 >Fax</code>, <code>Group4</code>, <code
1519 >JPEG</code>, <code>JPEG2000</code>, <code
1520 >Lossless</code>, <code>LZW</code>, <code
1521 >RLE</code> or <code>Zip</code>.</p>
1523 <p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1526 <p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1527 uncompressed format. The default is the compression type of the specified
1530 <p>If <code>LZW</code> compression is specified but LZW compression has not been
1531 enabled, the image data is written in an uncompressed LZW format that can be
1532 read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1534 <p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1535 JPEG library has been patched to support it. Use of lossless JPEG is generally
1536 not recommended.</p>
1539 When writing an ICO file, you may request that the images be encoded in
1540 PNG format, by specifying <code>Zip</code> compression.</p>
1543 When writing a JNG file, specify <code>Zip</code> compression to request that
1544 the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1545 to request that it be encoded in JPG "JDAA" format.</p>
1547 <p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1548 to be used by JPEG, PNG, MIFF, and MPEG encoders.
1549 Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1550 sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1551 the chroma channels.</p>
1553 <div style="margin: auto;">
1554 <h3><a class="anchor" id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1557 <p class="magick-description"><a href="connected-components.html">connected-components</a> labeling detects connected regions in an image, choose from 4 or 8 way connectivity.</p>
1559 <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>
1561 <div style="margin: auto;">
1562 <h3><a class="anchor" id="contrast"></a>-contrast</h3>
1565 <p class="magick-description">Enhance or reduce the image contrast.</p>
1567 <p>This option enhances the intensity differences between the lighter and
1568 darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1569 the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1572 <p>For a more pronounced effect you can repeat the option:</p>
1574 <pre class="highlight"><code>convert rose: -contrast -contrast rose_c2.png
1577 <div style="margin: auto;">
1578 <h3><a class="anchor" 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>
1581 <p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1583 <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
1584 <var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
1586 <p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1587 >-contrast-stretch</a> will black-out at most <var>black-point</var> pixels and white-out at most <var >total pixels
1588 minus 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>
1590 <p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1591 the 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
1592 clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1593 >-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
1594 prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1596 <p>Internally operator works by creating a histogram bin, and then uses that
1597 bin to modify the image. As such some colors may be merged together when they
1598 originally fell into the same 'bin'. </p>
1600 <p>All the channels are normalized in concert by the same amount so as to
1601 preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1602 setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
1603 setting will normalize the RGB channels independently.</p>
1605 <p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
1606 normalization of mathematical images. </p>
1608 <p>This operator is under review for re-development. </p>
1611 <div style="margin: auto;">
1612 <h3><a class="anchor" id="convolve"></a>-convolve <var>kernel</var></h3>
1615 <p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1617 <p>The <var>kernel</var> is a matrix specified as
1618 a comma-separated list of integers (with no spaces), ordered left-to right,
1619 starting with the top row. Presently, only odd-dimensioned kernels are
1620 supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
1621 7<sup>2</sup>=49, etc. </p>
1623 <p>Note that the <a href="command-line-options.html#convolve">‑convolve</a> operator supports the <a href="command-line-options.html#bias">‑bias</a> setting. This option shifts the convolution so that
1624 positive and negative results are relative to a user-specified bias value.
1625 This is important for non-HDRI compilations of ImageMagick when dealing with
1626 convolutions that contain negative as well as positive values. This is
1627 especially the case with convolutions involving high pass filters or edge
1628 detection. Without an output bias, the negative values is clipped at zero.
1631 <p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">‑bias</a> is not needed, as ImageMagick is able to store/handle any
1632 negative results without clipping to the color value range (0..QuantumRange).
1633 See the discussion on HDRI implementations of ImageMagick on the page <a
1634 href="high-dynamic-range.html">High
1635 Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1636 href="../Usage/basics/#hdri">Usage</a> pages or this
1637 <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1641 <div style="margin: auto;">
1642 <h3><a class="anchor" id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1645 <p class="magick-description">copy pixels from one area of an image to another.</p>
1647 <div style="margin: auto;">
1648 <h3><a class="anchor" id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1651 <p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1653 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1655 <p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1656 after cropping, and <var>x</var> and <var>y</var> in the
1657 <var>offset</var> (if present) gives the location of the top left
1658 corner of the cropped image with respect to the original image. To specify the
1659 amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1661 <p>If the <var>x</var> and <var>y</var> offsets are
1662 present, a single image is generated, consisting of the pixels from the
1663 cropping region. The offsets specify the location of the upper left corner of
1664 the cropping region measured downward and rightward with respect to the upper
1665 left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1666 present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1667 gravity, it gives the distance leftward from the right edge of the image to
1668 the right edge of the cropping region. Similarly, if the <a
1669 href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
1670 <code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1671 upward between the bottom edges.</p>
1673 <p>If the <var>x</var> and <var>y</var> offsets are
1674 omitted, a set of tiles of the specified geometry, covering the entire input
1675 image, is generated. The rightmost tiles and the bottom tiles are smaller if
1676 the specified geometry extends beyond the dimensions of the input image.</p>
1678 <p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1680 <p>By adding a exclamation character flag to the geometry argument, the
1681 cropped images virtual canvas page size and offset is set as if the
1682 geometry argument was a viewport or window. This means the canvas page size
1683 is set to exactly the same size you specified, the image offset set
1684 relative top left corner of the region cropped. </p>
1686 <p>If the cropped image 'missed' the actual image on its virtual canvas, a
1687 special single pixel transparent 'missed' image is returned, and a 'crop
1688 missed' warning given. </p>
1690 <p>It might be necessary to <a href="command-line-options.html#repage" >+repage</a> the image prior to
1691 cropping the image to ensure the crop coordinate frame is relocated to the
1692 upper-left corner of the visible image.
1694 Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
1695 remove the page offset that will be left behind. This is especially true when
1696 you are going to write to an image format such as PNG that supports an image
1699 <div style="margin: auto;">
1700 <h3><a class="anchor" id="cycle"></a>-cycle <var>amount</var></h3>
1703 <p class="magick-description">displace image colormap by amount.</p>
1705 <p><var>Amount</var> defines the number of positions each
1706 colormap entry is shifted.</p>
1709 <div style="margin: auto;">
1710 <h3><a class="anchor" id="debug"></a>-debug <var>events</var></h3>
1713 <p class="magick-description">enable debug printout.</p>
1715 <p>The <code>events</code> parameter specifies which events are to be logged. It
1716 can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1717 a comma-separated list consisting of one or more of the following domains:
1718 <code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1719 <code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1720 <code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1721 <code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1722 <code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1725 <p>For example, to log cache and blob events, use.</p>
1727 <pre class="highlight"><code>convert -debug "Cache,Blob" rose: rose.png
1730 <p>The <code>User</code> domain is normally empty, but developers can log user
1731 events in their private copy of ImageMagick.</p>
1733 <p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1736 <p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1739 <p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1741 <p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1742 >environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
1743 environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1747 <div style="margin: auto;">
1748 <h3><a class="anchor" id="decipher"></a>-decipher <var>filename</var></h3>
1751 <p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1753 <p>Get the passphrase from the file specified by <var>filename</var>.</p>
1755 <p>For more information, see the webpage, <a
1756 href="../www/cipher.html">ImageMagick: Encipher or
1757 Decipher an Image</a>.</p>
1760 <div style="margin: auto;">
1761 <h3><a class="anchor" id="deconstruct"></a>-deconstruct</h3>
1764 <p class="magick-description">find areas that has changed between images </p>
1766 <p>Given a sequence of images all the same size, such as produced by <a
1767 href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
1768 a smaller image of just the area that changed relative to the previous image.
1771 <p>The resulting sequence of images can be used to optimize an animation
1772 sequence, though will not work correctly for GIF animations when parts of the
1773 animation can go from opaque to transparent. </p>
1775 <p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1776 method '<code>compare-any</code>'. </p>
1779 <div style="margin: auto;">
1780 <h3><a class="anchor" id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1783 <p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1785 <p>This option creates one or more definitions for coders and decoders to use
1786 while reading and writing image data. Definitions are generally used to
1787 control image file format coder modules, and image processing operations,
1788 beyond what is provided by normal means. Defined settings are listed in <a
1789 href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
1790 as "Artifacts". </p>
1792 <p>If <var>value</var> is missing for a definition, an empty-valued
1793 definition of a flag is created with that name. This used to control on/off
1794 options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1795 previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1796 existing definitions.</p>
1798 <p>The same 'artifact' settings can also be defined using the <a
1799 href="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
1800 Properties</a> in the defined value. </p>
1802 <p>The <var>option</var> and <var>key</var> are case-independent (they are
1803 converted to lowercase for use within the decoders) while the <var>value</var>
1804 is case-dependent.</p>
1806 <p>Such settings are global in scope, and affect all images and operations. </p>
1808 <p>The following definitions are just some of the artifacts that are
1811 <table class="table table-sm table-striped">
1813 <td>bmp3:alpha=<var>true|false</var></td>
1814 <td>include any alpha channel when writing in the BMP image format.</td>
1818 <td>bmp:format=<var>value</var></td>
1819 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1820 and <var>bmp4</var>. This option can be useful when the
1821 method of prepending "BMP2:" to the output filename is inconvenient or
1822 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1826 <td>colorspace:auto-grayscale=<var>on|off</var></td>
1827 <td>prevent automatic conversion to grayscale inside coders that support
1828 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1829 not need this define. With PNG, just use PNG24:image. With TIF, just use
1830 -type truecolor. JPG and PSD will need this define.</td>
1834 <td>complex:snr=<var>value</var></td>
1835 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1839 <td>compose:args=<var>arguments</var></td>
1840 <td>Sets certain compose argument values when using convert ... -compose ...
1841 -composite. See <a href="compose.html"
1842 >Image Composition</a></td>
1846 <td>compose:clamp=<var>on|off</var></td>
1847 <td>set each pixel whose value is below zero to zero and any the pixel
1848 whose value is above the quantum range to the quantum range (e.g. 65535)
1849 otherwise the pixel value remains unchanged. Define supported in
1850 ImageMagick 6.9.1-3 and above.</td>
1854 <td>connected-components:area-threshold=<var>value</var></td>
1855 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1859 <td>connected-components:keep=<var>list-of-ids</var></td>
1860 <td>Comma and/or hyphenated list of id values to keep in the output.
1861 Supported in Imagemagick 6.9.3-0.</td>
1865 <td>connected-components:mean-color=<var>true</var></td>
1866 <td>Changes the output image from id values to mean color values. Supported
1867 in Imagemagick 6.9.2-8.</td>
1871 <td>connected-components:remove=<var>list-of-ids</var></td>
1872 <td>Comma and/or hyphenated list of id values to remove from the output.
1873 Supported in Imagemagick 6.9.2-9.</td>
1877 <td>connected-components:verbose=<var>true</var></td>
1878 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1882 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1883 <td>Defines the kernel scaling. The special flag ! automatically scales to
1884 full dynamic range. The ! flag can be used in combination with a factor or
1885 percent. The factor or percent is then applied after the automatic scaling.
1886 An example is 50%!. This produces a result 50% darker than full dynamic
1887 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1888 example when some values are positive and some are negative as in edge
1889 detection kernels. The origin addition adds that value to the center
1890 pixel of the kernel. This produces an effect that is like adding the image
1891 that many times to the result of the filtered image. The typical value
1892 is 1 so that the original image is added to the result of the convolution.
1893 The default is 0.</td>
1897 <td>convolve:showkernel=<var>1</var></td>
1898 <td>Outputs (to 'standard error') all the information about a specified <a
1899 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
1903 <td>dcm:display-range=<var>reset</var></td>
1904 <td>Sets the display range to the minimum and maximum pixel values for the
1905 DCM image format.</td>
1909 <td>dds:cluster-fit=<var>true|false</var></td>
1910 <td>Enables the dds cluster-fit.</td>
1914 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1915 <td>Sets the dds compression.</td>
1919 <td>dds:mipmaps=<var>value</var></td>
1920 <td>Sets the dds number of mipmaps.</td>
1924 <td>dds:weight-by-alpha=<var>true|false</var></td>
1925 <td>Enables the dds alpha weighting.</td>
1929 <td>deskew:auto-crop=<var>true</var></td>
1930 <td>auto crop the image after deskewing.</td>
1934 <td>delegate:bimodal=<var>true</var></td>
1935 <td>Specifies direct conversion from Postscript to PDF.</td>
1939 <td>distort:scale=<var>value</var></td>
1940 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1945 <td>distort:viewport=<var>WxH+X+Y</var></td>
1946 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1950 <td>dot:layout-engine=<var>value</var></td>
1951 <td>Specifies the layout engine for the DOT image format (e.g.
1952 <code>neato</code>).</td>
1956 <td>exr:color-type=<var>value</var></td>
1957 <td>Specifies the color type for the EXR format: RGB, RGBA, YC, YCA, Y, YA, R, G, B, A).</td>
1961 <td>filter:option=<var>value</var></td>
1962 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1963 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1967 <td>fourier:normalize=<var>inverse</var></td>
1968 <td>Sets the location for the FFT/IFT normalization as use by
1969 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1970 <var>forward</var>.</td>
1974 <td>h:format=<var>value</var></td>
1975 <td>Set the image encoding format use when writing a C-style header.
1976 <var>format</var> can be any output format supported by ImageMagick
1977 except for <var>h</var> and <var>magick</var>. If this
1978 option is omitted, the default is <var>GIF</var> for PseudoClass
1979 images and <var>PNM</var> for DirectClass images.
1984 <td>icon:auto-resize</td>
1985 <td>Automatically stores multiple sizes when writing an ico image
1986 (requires a 256x256 input image).</td>
1990 <td>identify:locate=<var>minimum|maximum</var></td>
1991 <td>Locates the coordinates of one or more image minimum or maximum</td>
1995 <td>identify:limit=<var>number</var></td>
1996 <td>Locates the coordinates for the number of minima or maxima specified</td>
2000 <td>jp2:layer-number=<var>value</var></td>
2001 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
2006 <td>jp2:number-resolutions=<var>value</var></td>
2007 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and
2012 <td>jp2:progression-order=<var>value</var></td>
2013 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
2018 <td>jp2:quality=<var>value,value...</var></td>
2019 <td>Sets the quality layer PSNR, given in dB. The order is from left to
2020 right in ascending order. The default is a single lossless quality layer.
2021 Same for JPT, JC2, and J2K</td>
2025 <td>jp2:rate=<var>value</var></td>
2026 <td>Specify the compression factor to use while writing JPEG-2000 files.
2027 The compression factor is the reciprocal of the compression ratio. The
2028 valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If
2029 defined, this value overrides the -quality setting. A quality setting
2030 of 75 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
2034 <td>jp2:reduce-factor=<var>value</var></td>
2035 <td>Sets the number of highest resolution levels to be discarded.Same for
2036 JPT, JC2, and J2K</td>
2040 <td>jpeg:block-smoothing=<var>on|off</var></td>
2045 <td>jpeg:colors=<var>value</var></td>
2046 <td>Set the desired number of colors and let the JPEG encoder do the
2051 <td>jpeg:dct-method=<var>value</var></td>
2052 <td>Choose from <code>default</code>, <code>fastest</code>,
2053 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
2057 <td>jpeg:extent=<var>value</var></td>
2058 <td>Restrict the maximum JPEG file size, for example <code>-define
2059 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
2060 compression quality level that results in an output file that does not
2061 exceed the value. The <code>-quality</code> option also will be respected
2062 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
2063 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
2064 -quality setting was ignored.</td>
2068 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
2073 <td>jpeg:optimize-coding=<var>on|off</var></td>
2078 <td>jpeg:q-table=<var>table</var></td>
2083 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
2088 <td>jpeg:size=<var>geometry</var></td>
2089 <td>Set the size hint of a JPEG image, for
2090 example, <code>-define jpeg:size=128x128</code>.
2091 It is most useful for increasing performance and reducing the memory
2092 requirements when reducing the size of a large JPEG image.</td>
2096 <td>json:features</td>
2097 <td>includes features in verbose information</td>
2106 <td>json:locate</td>
2111 <td>json:moments</td>
2112 <td>includes image moments in verbose information</td>
2116 <td>magick:format=<var>value</var></td>
2117 <td>Set the image encoding format use when writing a C-style header.
2118 This is the same as "h:format=format" described above.</td>
2122 <td>mng:need-cacheoff</td>
2123 <td>turn playback caching off for streaming MNG.</td>
2127 <td>morphology:compose=<var>compose-method</var></td>
2128 <td>Specifies how to merge results generated by multiple<a
2129 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
2130 typical value is 'lighten' as used, for example, with the sobel edge
2135 <td>morphology:showkernel=<var>1</var></td>
2136 <td>Outputs (to 'standard error') all the information about a generated <a
2137 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
2141 <td>pcl:fit-to-page=<var>true</var></td>
2145 <td>pdf:fit-page=<var>geometry</var></td>
2146 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2147 being read. The geometry is either WxH{%} or page size. No offsets are
2148 allowed. (introduced in IM 6.8.8-8)</td>
2152 <td>pdf:fit-to-page=<var>true</var></td>
2157 <td>pdf:use-cropbox=<var>true</var></td>
2162 <td>pdf:use-trimbox=<var>true</var></td>
2167 <td>pdf:stop-on-error=<var>true</var></td>
2172 <td>pdf:pdf:page-direction=<var>right-to-left</var></td>
2177 <td>phash:colorspaces=<var>colorspace,colorspace,...</var></td>
2178 <td>the perceptual hash defaults to the sRGB and HCLp colorspaces. When
2179 using this define, you can specify up to six alternative colorspaces. (as
2184 <td>phash:normalize=<var>true</var></td>
2185 <td>normalizes the phash metric by dividing by the number of channels
2186 specified by <code>-define phash:colorspaces</code> when using compare
2187 -metric phash. (as of IM 7.0.3-8)</td>
2191 <td>png:bit-depth=<var>value</var></td>
2196 <td>png:color-type=<var>value</var></td>
2197 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2198 encoder to use a different bit-depth and color-type than it would have
2199 normally selected, but only if this does not cause any loss of image
2200 quality. Any attempt to reduce image quality is treated as an error and no
2201 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2202 can use these "defines" to cause it to be written as an 8-bit grayscale,
2203 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2204 you cannot force it to be written as a grayscale or indexed PNG. If you
2205 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2206 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2207 reduce the image quality prior to using the PNG encoder. Note that in
2208 indexed PNG files, "bit-depth" refers to the number of bits per index,
2209 which can be 1, 2, 4, or 8. In such files, the color samples always have
2214 <td>png:compression-filter=<var>value</var></td>
2215 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2216 5 means adaptive filtering except for images with a colormap, 6 means
2217 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2218 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2223 <td>png:compression-level=<var>value</var></td>
2224 <td> valid values are 0 through 9, with 0 providing the least but fastest
2225 compression and 9 usually providing the best and always the slowest.</td>
2229 <td>png:compression-strategy=<var>value</var></td>
2230 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2231 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2232 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2233 values 3 and 4, respectively, will use the zlib default strategy
2238 <td>png:format=<var>value</var></td>
2239 <td> valid values are <var>png8</var>, <var>png24</var>,
2240 <var>png32</var>, <var>png48</var>,
2241 <var>png64</var>, and <var>png00</var>.
2242 This property can be useful for specifying
2243 the specific PNG format to be used, when the usual method of prepending the
2244 format name to the output filename is inconvenient, such as when writing
2245 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2246 Value = <var>png8</var> reduces the number of colors to 256,
2247 only one of which may be fully transparent, if necessary. The other
2248 values do not force any reduction of quality; it is an error to request
2249 a format that cannot represent the image data without loss (except that
2250 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2251 Value = <var>png24</var> and <var>png48</var>
2252 allow transparency, only if a single color is fully transparent and that
2253 color does not also appear in an opaque pixel; such transparency is
2254 written in a PNG <code>tRNS</code> chunk.
2255 Value = <var>png00</var> causes the image to inherit its
2256 color-type and bit-depth from the input image, if the input was also
2261 <td>png:exclude-chunk=<var>value</var></td>
2264 <td>png:include-chunk=<var>value</var></td>
2265 <td>ancillary chunks to be excluded from or included in PNG output.
2267 <p>The <var>value</var> can be the name of a PNG chunk-type such
2268 as <var>bKGD</var>, a comma-separated list of chunk-names
2269 (which can include the word <var>date</var>, the word
2270 <var>all</var>, or the word <var>none</var>).
2271 Although PNG chunk-names are case-dependent, you can use all lowercase
2272 names if you prefer.</p>
2274 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2275 of the PNG encoder and have no effect on the PNG decoder.</p>
2277 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2278 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2279 only be written if gamma is not 1/2.2, since most decoders assume
2280 sRGB and gamma=1/2.2 when no colorspace information is included in
2281 the PNG file. Because the list is processed from left to right, you
2282 can achieve this with a single define:</p>
2284 <pre class="highlight"><code>-define png:include-chunk=none,gAMA
2287 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2288 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2289 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2290 entire ICC profile. To force the PNG encoder to write the sRGB
2291 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2292 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2294 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2295 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2296 entries appearing in the list will be ignored.</p>
2298 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2299 image has transparency, the PNG colortype is forced to be 4 or 6
2300 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2301 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2302 on the PNG colortype of the output image.</p>
2304 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2305 following for PNG output:</p>
2307 <pre class="highlight"><code>-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2310 <p>The default behavior is to include all known PNG ancillary chunks
2311 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2312 and to exclude all PNG chunks that are unknown to ImageMagick,
2313 regardless of their PNG "copy-safe" status as described in the
2314 PNG specification.</p>
2316 <p>Any chunk names that are not known to ImageMagick are ignored
2317 if they appear in either the "include-chunk" or "exclude-chunk" list.
2318 The ancillary chunks currently known to ImageMagick are
2319 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2320 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2321 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2323 <p>You can also put <code>date</code> in the list to include or exclude
2324 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2325 inserts in the output PNG.</p></td>
2329 <td>png:preserve-colormap[=<var>true</var>]</td>
2330 <td>Use the existing image->colormap. Normally the PNG encoder will
2331 try to optimize the palette, eliminating unused entries and putting
2332 the transparent colors first. If this flag is set, that behavior
2337 <td>png:preserve-iCCP[=<var>true</var>]</td>
2338 <td>By default, the PNG decoder and encoder examine any ICC profile
2339 that is present, either from an <code>iCCP</code> chunk in the PNG
2340 input or supplied via an option, and if the profile is recognized
2341 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2342 You can use <code>-define png:preserve-iCCP</code> to prevent
2343 this from happening; in such cases the <code>iCCP</code> chunk
2344 will be read or written and no <code>sRGB</code> chunk will be
2345 written. There are some ICC profiles that claim to be sRGB but
2346 have various errors that cause them to be rejected by libpng16; such
2347 profiles are recognized anyhow and converted to the <code>sRGB</code>
2348 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2349 is present. Note that not all "sRGB" ICC profiles are recognized
2350 yet; we will add them to the list as we encounter them.</td>
2354 <td>png:swap-bytes[=<var>true</var>]</td>
2355 <td>The PNG specification requires that any multi-byte integers be stored in
2356 network byte order (MSB-LSB endian). This option allows you to
2357 fix any invalid PNG files that have 16-bit samples stored incorrectly
2358 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2359 must appear before the input filename on the commandline. The swapping
2360 is done during the libpng decoding operation.</td>
2364 <td>profile:skip=<var>name1,name2,...</var></td>
2365 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2366 skip all named profiles in the image. Many named profiles exist,
2367 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2371 <td>ps:imagemask</td>
2372 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2373 create Postscript files that render bilevel images with the Postscript
2374 imagemask operator instead of the image operator.</td>
2378 <td>psd:additional-info=all|selective</td>
2379 <td>This option should only be used when converting from a PSD file to
2380 another PSD file. This should be placed after the image is read. The two
2381 options are 'all' and 'selective'. The 'selective' option will preserve
2382 all additional information that is not related to the geometry of the
2383 image. The 'all' option should only be used when the geometry of the
2384 image has not been changed. This option is helpful when transferring
2385 non-simple layers, such as adjustment layers from the input PSD file to
2386 the output PSD file. If this option is not used, the additional
2387 information will not be preserved. This define is available as of
2388 Imagemagick version 6.9.5-8.
2393 <td>psd:alpha-unblend=off</td>
2394 <td>Disables new automatic un-blending of transparency with the base image
2395 for the flattened layer 0 before adding the alpha channel to the output
2396 image. This define must be placed before the input psd image. (Available
2397 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2398 prevents the transparency from being applied twice in the output
2399 image. This option should be set before reading the image.</td>
2403 <td>psd:preserve-opacity-mask=true</td>
2404 <td>This option should only be used when converting from a PSD file to
2405 another PSD file. It will preserve the opacity mask of a layer and add it
2406 back to the layer when the image is saved. Setting this to 'true' will
2407 enable this feature. This define is available as of Imagemagick version
2413 <td>preserve-timestamp=<var>{True, False}</var></td>
2414 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2418 <td>quantum:format=<var>type</var></td>
2419 <td>Set the type to <code>floating-point</code> to specify a floating-point
2420 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2421 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2422 included, the result is a single precision floating point format.
2423 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2424 double precision floating point format.</td>
2428 <td>quantum:polarity=<var>photometric-interpretation</var></td>
2429 <td>Set the photometric-interpretation of an image (typically for TIFF
2430 image file format) to either <code>min-is-black</code> (default) or
2431 <code>min-is-white</code>.</td>
2435 <td>sample:offset=<var>geometry</var></td>
2436 <td>Location of the sampling point within the sub-region being sampled,
2437 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
2441 <td>showkernel=<var>1</var></td>
2442 <td>Outputs (to 'standard error') all the information about a generated <a
2443 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
2447 <td>stream:buffer-size=<var>value</var></td>
2448 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2452 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
2453 <td>Specify the alpha extra samples as associated, unassociated or
2458 <td>tiff:endian=<var>msb|lsb</var></td>
2463 <td>tiff:exif-properties=<var>true</var></td>
2464 <td>Enables reading the EXIF properties.</td>
2468 <td>tiff:fill-order=<var>msb|lsb</var></td>
2473 <td>tiff:ignore-layers=<var>true</var></td>
2474 <td>Ignores the photoshop layers.</td>
2478 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2479 <td>Allows one or more tag ID values to be ignored.</td>
2483 <td>tiff:rows-per-strip=<var>value</var></td>
2484 <td>Sets the number of rows per strip</td>
2488 <td>tiff:tile-geometry=<var>WxH</var></td>
2489 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2490 PTIF: before the outputname</td>
2494 <td>type:features=<var>string</var></td>
2499 <td>type:hinting=<var>off</var></td>
2504 <td>txt:compliance=<var>css</var></td>
2509 <td>x:screen=<var>true</var></td>
2510 <td>Obtains the image from the root window </td>
2514 <td>x:silent=<var>true</var></td>
2515 <td>Turns off the beep when importing an image </td>
2519 <p>For example, to create a postscript file that will render only the black
2520 pixels of a bilevel image, use:</p>
2522 <pre class="highlight"><code>convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2525 <p>Set attributes of the image registry by prefixing the value with
2526 <code>registry:</code>. For example, to set a temporary path to put work files,
2529 <pre class="highlight"><code>-define registry:temporary-path=/data/tmp
2532 <div style="margin: auto;">
2533 <h3><a class="anchor" id="delay"></a>-delay <var>ticks</var> <br />-delay <var>ticks</var>x<var>ticks-per-second</var> {<var><</var>} {<var>></var>}</h3>
2536 <p class="magick-description">display the next image after pausing.</p>
2538 <p>This option is useful for regulating the animation of image sequences
2539 <var>ticks/ticks-per-second</var> seconds must expire before the display of the
2540 next image. The default is no delay between each showing of the image
2541 sequence. The default ticks-per-second is 100.</p>
2543 <p>Use <code>></code> to change the image delay <var>only</var> if its current
2544 value exceeds the given delay. <code><</code> changes the image delay
2545 <var>only</var> if current value is less than the given delay. For example, if
2546 you specify <code>30></code> and the image delay is 20, the image delay does
2547 not change. However, if the image delay is 40 or 50, the delay it is changed
2548 to 30. Enclose the given delay in quotation marks to prevent the
2549 <code><</code> or <code>></code> from being interpreted by your shell as
2550 a file redirection.</p>
2553 <div style="margin: auto;">
2554 <h3><a class="anchor" id="delete"></a>-delete <var>indexes</var></h3>
2557 <p class="magick-description">delete the images specified by index, from the image sequence.</p>
2559 <p>Specify the image by its index in the sequence. The first image is index
2560 0. Negative indexes are relative to the end of the sequence, for example, -1
2561 represents the last image of the sequence. Specify a range of images with
2562 a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
2563 <code>+delete</code> to delete the last image in the current image sequence. Use <code>-delete 0--1</code> to delete the entire image sequence.</p>
2566 <div style="margin: auto;">
2567 <h3><a class="anchor" id="density"></a>-density <var>width</var><br />-density <var>width</var>x<var>height</var></h3>
2570 <p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2572 <p>This option specifies the image resolution to store while encoding a raster
2573 image or the canvas resolution while rendering (reading) vector formats such
2574 as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2575 provides the unit of measure to apply when rendering to an output device or
2576 raster image. The default unit of measure is in dots per inch (DPI). The <a
2577 href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
2580 <p>The default resolution is 72 dots per inch, which is equivalent to one
2581 point per pixel (Macintosh and Postscript standard). Computer screens are
2582 normally 72 or 96 dots per inch, while printers typically support 150, 300,
2583 600, or 1200 dots per inch. To determine the resolution of your display, use
2584 a ruler to measure the width of your screen in inches, and divide by the
2585 number of horizontal pixels (1024 on a 1024x768 display).</p>
2587 <p>If the file format supports it, this option may be used to update the
2588 stored image resolution. Note that Photoshop stores and obtains image
2589 resolution from a proprietary embedded profile. If this profile is not
2590 stripped from the image, then Photoshop will continue to treat the image using
2591 its former resolution, ignoring the image resolution specified in the standard
2594 <p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2595 does not alter the underlying raster image. It may be used to adjust the
2596 rendered size for desktop publishing purposes by adjusting the scale applied
2597 to the pixels. To resize the image so that it is the same size at a different
2598 resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2600 <div style="margin: auto;">
2601 <h3><a class="anchor" id="depth"></a>-depth <var>value</var></h3>
2604 <p class="magick-description">depth of the image.</p>
2606 <p>This the number of bits in a color sample within a pixel. Use this option
2607 to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2608 or CMYK, or to change the depth of any image after it has been read.</p>
2610 <div style="margin: auto;">
2611 <h3><a class="anchor" id="descend"></a>-descend</h3>
2614 <p class="magick-description">obtain image by descending window hierarchy.</p>
2616 <div style="margin: auto;">
2617 <h3><a class="anchor" id="deskew"></a>-deskew <var>threshold{%}</var></h3>
2620 <p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2622 <p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
2623 <var>true | false</var></code> to auto crop the image.</p>
2625 <div style="margin: auto;">
2626 <h3><a class="anchor" id="despeckle"></a>-despeckle</h3>
2629 <p class="magick-description">reduce the speckles within an image.</p>
2631 <div style="margin: auto;">
2632 <h3><a class="anchor" id="direction"></a>-direction <var>type</var></h3>
2635 <p class="magick-description">render text right-to-left or left-to-right.</p>
2637 <div style="margin: auto;">
2638 <h3><a class="anchor" id="displace"></a>-displace <var>horizontal-scale</var>{%}{!}<br />-displace <var>horizontal-scale</var>x<var>vertical-scale</var>{%}{!}</h3>
2641 <p class="magick-description">shift image pixels as defined by a displacement map.</p>
2643 <p>With this option, the 'overlay' image, and optionally the 'mask' image,
2644 is used as a displacement map, which is used to displace the lookup of
2645 what part of the 'background' image is seen at each point of the overlaid
2646 area. Much like the displacement map is a 'lens' that redirects light shining
2647 through it so as to present a distorted view the original 'background' image
2650 <p>Any perfect grey areas of the displacement map produce a zero
2651 displacement of the image. Black areas produce the given maximum negative
2652 displacement of the lookup point, while white produce a maximum positive
2653 displacement of the lookup. </p>
2655 <p>Note that it is the lookup of the 'background' that is displaced, not a
2656 displacement of the image itself. As such an area of the displacement map
2657 containing 'white' will have the lookup point 'shifted' by a positive amount,
2658 and thus generating a copy of the destination image to the right/downward from
2659 the correct position. That is the image will look like it may have been
2660 'shifted' in a negative left/upward direction. Understanding this is a very
2661 important in understanding how displacement maps work. </p>
2663 <p>The given arguments define the maximum amount of displacement in pixels
2664 that a particular map can produce. If the displacement scale is large enough
2665 it is also possible to lookup parts of the 'background' image that lie well
2666 outside the bounds of the displacement map itself. That is you could very
2667 easily copy a section of the original image from outside the overlay area
2668 into the overlay area. </p>
2670 <p>The '%' flag makes the displacement scale relative to the size of the
2671 overlay image (100% = half width/height of image). Using '!' switches
2672 percentage arguments to refer to the destination image size instead.
2673 these flags were added as of IM v6.5.3-5.</p>
2675 <p>Normally a single grayscale displacement map is provided, which with the
2676 given scaling values will determine a single direction (vector) in which
2677 displacements can occur (positively or negatively). However, if you also
2678 specify a third image which is normally used as a <var>mask</var>,
2679 the <var>composite image</var> is used for horizontal X
2680 displacement, while the <var>mask image</var> is used for vertical Y
2681 displacement. This allows you to define completely different displacement
2682 values for the X and Y directions, and allowing you to lookup any point within
2683 the <var>scale</var> bounds. In other words each pixel can lookup
2684 any other nearby pixel, producing complex 2 dimensional displacements, rather
2685 than a simple 1 dimensional vector displacements. </p>
2687 <p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2688 you can use the 'red' channel of the overlay image to specify the horizontal
2689 or X displacement, and the 'green' channel for the vertical or Y displacement.
2692 <p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2693 mask the transparency of the destination image. However areas outside the
2694 overlaid areas will not be affected. </p>
2697 <div style="margin: auto;">
2698 <h3><a class="anchor" id="display"></a>-display <var>host:display[.screen]</var></h3>
2701 <p class="magick-description">Specifies the X server to contact.</p>
2703 <p>This option is used with convert for obtaining image or font from this
2704 X server. See <var>X(1)</var>.</p>
2706 <div style="margin: auto;">
2707 <h3><a class="anchor" id="dispose"></a>-dispose <var>method</var></h3>
2710 <p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2712 <p>The layer disposal method defines the way each the displayed image is to be
2713 modified after the current 'frame' of an animation has finished being
2714 displayed (after its 'delay' period), but before the next frame on an
2715 animation is to be overlaid onto the display. </p>
2717 <p>Here are the valid methods:</p>
2720 <dt class="col-md-4">Undefined</dt><dd class="col-md-8">0: No disposal specified (equivalent to '<code>none</code>').</dd>
2721 <dt class="col-md-4">None</dt><dd class="col-md-8">1: Do not dispose, just overlay next frame image.</dd>
2722 <dt class="col-md-4">Background</dt><dd class="col-md-8">2: Clear the frame area with the background color.</dd>
2723 <dt class="col-md-4">Previous</dt><dd class="col-md-8">3: Clear to the image prior to this frames overlay.</dd>
2726 <p>You can also use the numbers given above, which is what the GIF format
2727 uses internally to represent the above settings. </p>
2729 <p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2731 <p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
2732 resetting the layer disposal methods of images being read in. </p>
2734 <p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2735 disposal method for images already in memory.</p>
2737 <div style="margin: auto;">
2738 <h3><a class="anchor" id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2741 <p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2744 <div style="margin: auto;">
2745 <h3><a class="anchor" id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2748 <p class="magick-description">dissolve an image into another by the given percent.</p>
2750 <p>The opacity of the composite image is multiplied by the given percent, then
2751 it is composited 'over' the main image. If <var>src_percent</var>
2752 is greater than 100, start dissolving the main image so it becomes
2753 transparent at a value of '<code>200</code>'. If both percentages
2754 are given, each image are dissolved to the percentages given. </p>
2756 <p>Note that dissolve percentages do not add, two opaque images dissolved
2757 '50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2758 images, you would need to use dissolve values of '50,100'. </p>
2760 <div style="margin: auto;">
2761 <h3><a class="anchor" id="distort"></a>-distort <var>method arguments</var></h3>
2764 <p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2766 <p>The <var>arguments</var> is a single string containing a list
2767 of floating point numbers separated by commas or spaces. The number of
2768 and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2770 <p>Choose from these distortion types:</p>
2772 <table class="table table-sm table-striped">
2774 <th style="width: 8%">Method</th>
2775 <th>Description</th>
2779 <td>ScaleRotateTranslate <br/> SRT</td>
2781 Distort image by first scaling and rotating about a given 'center',
2782 before translating that 'center' to the new location, in that order. It
2783 is an alternative method of specifying a 'Affine' type of
2784 distortion, but without shearing effects. It also provides a good way
2785 of rotating and displacing a smaller image for tiling onto a larger
2786 background (IE 2-dimensional animations). <br/>
2788 The number of arguments determine the specific meaning of each
2789 argument for the scales, rotation, and translation operations. <br/>
2792 <dt class="col-md-4">2:</dt><dd class="col-md-8"><var>Scale Angle</var></dd>
2793 <dt class="col-md-4">3:</dt><dd class="col-md-8"><var>X,Y Angle</var></dd>
2794 <dt class="col-md-4">4:</dt><dd class="col-md-8"><var>X,Y Scale Angle</var></dd>
2795 <dt class="col-md-4">5:</dt> <dd class="col-md-8"><var>X,Y ScaleX,ScaleY Angle</var></dd>
2796 <dt class="col-md-4">6:</dt> <dd class="col-md-8"><var>X,Y Scale Angle NewX,NewY</var></dd>
2797 <dt class="col-md-4">7:</dt> <dd class="col-md-8"><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2800 This is actually an alternative way of specifying a 2 dimensional linear
2801 'Affine' or 'AffineProjection' distortion. </td> </tr>
2806 Distort the image linearly by moving a list of at least 3 or more sets
2807 of control points (as defined below). Ideally 3 sets or 12 floating
2808 point values are given allowing the image to be linearly scaled,
2809 rotated, sheared, and translated, according to those three points. See
2810 also the related 'AffineProjection' and 'SRT'
2813 More than 3 sets given control point pairs (12 numbers) is least
2814 squares fitted to best match a linear affine distortion. If only 2
2815 control point pairs (8 numbers) are given a two point image translation
2816 rotation and scaling is performed, without any possible shearing,
2817 flipping or changes in aspect ratio to the resulting image. If only one
2818 control point pair is provides the image is only translated, (which may
2819 be a floating point non-integer translation). <br/>
2821 This distortion does not include any form of perspective distortion.
2827 <td>AffineProjection</td>
2829 Linearly distort an image using the given Affine Matrix of 6
2830 pre-calculated coefficients forming a set of Affine Equations to map
2831 the source image to the destination image.
2833 <p class="text-center"><var>
2834 s<sub>x</sub>, r<sub>x</sub>,
2835 r<sub>y</sub>, s<sub>y</sub>,
2836 t<sub>x</sub>, t<sub>y</sub>
2839 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2840 meanings of these coefficients. <br/>
2842 The distortions 'Affine' and 'SRT' provide
2843 alternative methods of defining this distortion, with ImageMagick doing
2844 the calculations needed to generate the required coefficients. You can
2845 see the internally generated coefficients, by using a <a
2846 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
2851 <td>BilinearForward<br/>
2852 BilinearReverse</td>
2854 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2855 16 values (see below). Not that lines may not appear straight after
2856 distortion, though the distance between coordinates will remain
2859 The 'BilinearForward' is used to map rectangles to any
2860 quadrilateral, while the 'BilinearReverse' form maps any
2861 quadrilateral to a rectangle, while preserving the straight line edges
2864 Note that 'BilinearForward' can generate invalid pixels
2865 which will be colored using the <a href="command-line-options.html#mattecolor" >-mattecolor</a>
2866 color setting. Also if the quadrilateral becomes 'flipped' the image
2867 may disappear. <br/>
2869 There are future plans to produce a true Bilinear distortion that will
2870 attempt to map any quadrilateral to any other quadrilateral, while
2871 preserving edges (and edge distance ratios).
2877 <td>Perspective</td>
2879 Perspective distort the images, using a list of 4 or more sets of
2880 control points (as defined below). More that 4 sets (16 numbers) of
2881 control points provide least squares fitting for more accurate
2882 distortions (for the purposes of image registration and panorama
2883 effects). Less than 4 sets will fall back to a 'Affine'
2884 linear distortion. <br/>
2886 Perspective Distorted images ensures that straight lines remain
2887 straight, but the scale of the distorted image will vary. The horizon
2888 is anti-aliased, and the 'sky' color may be set using the
2889 <a href="command-line-options.html#mattecolor" >-mattecolor</a> setting. </td>
2893 <td>PerspectiveProjection </td>
2895 Do a 'Perspective' distortion biased on a set of 8
2896 pre-calculated coefficients. You can get these coefficients by looking
2897 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
2898 'Perspective' distortion, or by calculating them yourself.
2899 If the last two perspective scaling coefficients are zero, the
2900 remaining 6 represents a transposed 'Affine Matrix'. </td>
2907 Arc the image (variation of polar mapping) over the angle given around
2911 <dt class="col-md-4">arc_angle</dt>
2912 <dd class="col-md-8">The angle over which to arc the image side-to-side</dd>
2913 <dt class="col-md-4">rotate_angle</dt>
2914 <dd class="col-md-8">Angle to rotate resulting image from vertical center</dd>
2915 <dt class="col-md-4">top_radius</dt>
2916 <dd class="col-md-8">Set top edge of source image at this radius</dd>
2917 <dt class="col-md-4">bottom_radius </dt>
2918 <dd class="col-md-8">Set bottom edge to this radius (radial scaling)</dd>
2921 The resulting image is always resized to best fit the resulting image,
2922 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
2923 preserve scale and aspect ratio of the original image as much as
2924 possible with the arguments given by the user. All four arguments will
2925 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2927 This a variation of a polar distortion designed to try to preserve the
2928 aspect ratio of the image rather than direct Cartesian to Polar
2935 Like 'Arc' but do a complete Cartesian to Polar mapping of
2936 the image. that is the height of the input image is mapped to the
2937 radius limits, while the width is wrapped around between the
2940 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
2942 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2943 center to the center of the image, and the angles going from -180 (top)
2944 to +180 (top). If <var>Rmax</var> is given the special value of
2945 '0', the the distance from the center to the nearest edge
2946 is used for the radius of the output image, which will ensure the whole
2947 image is visible (though scaled smaller). However a special value of
2948 '-1' will use the distance from the center to the furthest
2949 corner, This may 'clip' the corners from the input rectangular image,
2950 but will generate the exact reverse of a 'DePolar' with
2951 the same arguments. <br/>
2953 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
2954 output image center will default to 0,0 of the virtual
2955 canvas, and the image size adjusted to ensure the whole input image is
2956 made visible in the output image on the virtual canvas. </td>
2963 Uses the same arguments and meanings as a 'Polar' distortion
2964 but generates the reverse Polar to Cartesian distortion. <br/>
2966 The special <var>Rmax</var> setting of '0' may however clip
2967 the corners of the input image. However using the special
2968 <var>Rmax</var> setting of '-1' (maximum center to corner
2969 distance) will ensure the whole distorted image is preserved in the
2970 generated result, so that the same argument to 'Polar' will
2971 reverse the distortion re-producing the original.
2973 Note that as this distortion requires the area resampling of a circular
2974 arc, which can not be handled by the builtin EWA resampling function.
2975 As such the normal EWA filters are turned off. It is recommended some
2976 form of 'super-sampling' image processing technique be used to produce
2977 a high quality result. </td>
2984 Given the four coefficients (A,B,C,D) as defined by <a
2985 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
2986 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2987 correct radial lens distortions. That is in photographs, make straight
2988 lines straight again. <br/>
2990 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
2991 <var>X</var> , <var>Y</var> ] ] <br/>
2992 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2993 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2994 [ <var>X</var> , <var>Y</var> ] </p>
2995 So that it forms the function
2996 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2997 <var>C</var>*r + <var>D</var> )</p>
2999 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
3000 (defaulting to the center of the image). <br/>
3001 The second form is typically used to distort images, rather than
3002 correct lens distortions. <br/>
3008 <td>BarrelInverse</td>
3010 This is very similar to 'Barrel' with the same set of
3011 arguments, and argument handling. However it uses the inverse
3012 of the radial polynomial,
3013 so that it forms the function
3014 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
3015 <var>C</var>*r + <var>D</var> )</p>
3016 Note that this is not the reverse of the 'Barrel'
3017 distortion, just a different barrel-like radial distortion method.
3025 Distort the given list control points (any number) using an Inverse
3026 Squared Distance Interpolation Method (<a
3027 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
3028 Method</a>). The control points in effect do 'localized' displacement
3029 of the image around the given control point (preserving the look and
3030 the rotation of the area near the control points. For best results
3031 extra control points should be added to 'lock' the positions of the
3032 corners, edges and other unchanging parts of the image, to prevent
3033 their movement. <br/>
3035 The distortion has been likened to 'taffy pulling' using nails, or
3036 pins' stuck in a block of 'jelly' which is then moved to the new
3037 position, distorting the surface of the jelly. <br/>
3039 Internally it is equivalent to generating a displacement map (see <a
3040 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
3041 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
3048 <p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
3051 <p>Many of the above distortion methods such as '<code>Affine</code>',
3052 '<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
3053 defining how these points in the given image should be distorted in the
3054 destination image. Each set of four floating point values represent a source
3055 image coordinate, followed immediately by the destination image coordinate.
3056 This produces a list of values such as...</p>
3057 <p class="text-center"><var>
3058 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
3059 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
3060 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
3062 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
3064 <p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
3065 destination image. </p>
3067 <p>For example, to warp an image using '<code>perspective</code>' distortion,
3068 needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
3069 perspective distortion of the built-in "rose:" image. Note how spaces were
3070 used to group the 4 sets of coordinate pairs, to make it easier to read and
3073 <pre class="highlight"><code>convert rose: -virtual-pixel black \
3074 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
3075 rose_3d_rotated.gif"
3078 <p>If more that the required number of coordinate pairs are given for
3079 a distortion, the distortion method is 'least squares' fitted to produce the
3080 best result for all the coordinate pairs given. If less than the ideal number
3081 of points are given, the distort will generally fall back to a simpler form of
3082 distortion that can handles the smaller number of coordinates (usually a linear
3083 '<code>Affine</code>' distortion). </p>
3085 <p>By using more coordinates you can make use of image registration tool to
3086 find matching coordinate pairs in overlapping images, so as to improve the
3087 'fit' of the distortion. Of course a bad coordinate pair can also make the
3088 'fit' worse. Caution is always advised. </p>
3090 <p>Colors are acquired from the source image according to a cylindrical
3091 resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
3092 EWA resampling. This produces very high quality results, especially when
3093 images become smaller (minified) in the output, which is very common when
3094 using '<code>perspective</code>' distortion. For example here we view
3095 a infinitely tiled 'plane' all the way to the horizon. </p>
3097 <pre class="highlight"><code>convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
3098 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
3102 <p>Note that a infinitely tiled perspective images involving the horizon can
3103 be very slow, because of the number of pixels that are compressed to generate
3104 each individual pixel close to the 'horizon'. You can turn off EWA
3105 resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
3106 '<code>point</code>' (recommended if you plan to use super-sampling instead).
3109 <p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
3110 example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
3111 href="command-line-options.html#mattecolor" >-mattecolor</a> setting for these pixels. If you do not
3112 what these pixels to be visible, set the color to match the rest of the
3115 <p>The output image size will by default be the same as the input image. This
3116 means that if the part of the distorted image falls outside the viewed area of
3117 the 'distorted space', those parts is clipped and lost. However if you use
3118 the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
3119 will attempt (if possible) to show the whole of the distorted image, while
3120 retaining a correct 'virtual canvas' offset, for image layering. This offset
3121 may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
3124 <p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
3125 href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
3126 and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
3127 and debugging purposes. This many not be available for all distorts. </p>
3129 <p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3130 >-define</a> distort:viewport={geometry_string}</code>" setting which will
3131 specify the size and the offset of the generated 'viewport' image of the
3132 distorted image space.</p>
3134 <p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
3135 distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
3136 otherwise) by that factor without changing the viewed contents of the
3137 distorted image. This can be used either for 'super-sampling' the image for
3138 a higher quality result, or for panning and zooming around the image (with
3139 appropriate viewport changes, or post-distort cropping and resizing). </p>
3141 <p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
3142 will output the cylindrical filter lookup table created by the EWA (Elliptical
3143 Weighted Average) resampling algorithm. Note this table uses a squared radius
3144 lookup value. This is typically only used for debugging EWA resampling. </p>
3147 <div style="margin: auto;">
3148 <h3><a class="anchor" id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3151 <p class="magick-description">launch a distributed pixel cache server. </p>
3153 <div style="margin: auto;">
3154 <h3><a class="anchor" id="dither"></a>-dither <var>method</var></h3>
3157 <p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3158 images when general color reduction is applied via an option, or automagically
3159 when saving to specific formats. This enabled by default.</p>
3161 <p>Dithering places two or more colors in neighboring pixels so that to the
3162 eye a closer approximation of the images original color is reproduced. This
3163 reduces the number of colors needed to reproduce the image but at the cost of
3164 a lower level pattern of colors. Error diffusion dithers can use any set of
3165 colors (generated or user defined) to an image. </p>
3167 <p>Dithering is turned on by default, to turn it off use the plus form of the
3168 setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3169 without text or graphic aliasing. Disabling dithering often (but not always)
3170 leads to faster process, a smaller number of colors, but more cartoon like
3171 image coloring. Generally resulting in 'color banding' effects in areas with
3172 color gradients. </p>
3174 <p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3175 href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3176 href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
3177 color set they created. These operators are also used as part of automatic
3178 color reduction when saving images to formats with limited color support, such
3179 as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3180 in these cases. </p>
3182 <p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
3183 to generate purely random dither. Or use <a
3184 href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
3185 patterns, using uniform color maps, rather than specific color maps. </p>
3188 <div style="margin: auto;">
3189 <h3><a class="anchor" id="draw"></a>-draw <var>string</var></h3>
3192 <p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3194 <p>Use this option to annotate or decorate an image with one or more graphic
3195 primitives. The primitives include shapes, text, transformations, and pixel
3198 <p>The shape primitives:</p>
3201 <dt class="col-md-4">point</dt><dd class="col-md-8"> x,y</dd>
3202 <dt class="col-md-4">line</dt><dd class="col-md-8"> x0,y0 x1,y1</dd>
3203 <dt class="col-md-4">rectangle</dt><dd class="col-md-8"> x0,y0 x1,y1</dd>
3204 <dt class="col-md-4">roundRectangle</dt><dd class="col-md-8"> x0,y0 x1,y1 wc,hc</dd>
3205 <dt class="col-md-4">arc</dt><dd class="col-md-8"> x0,y0 x1,y1 a0,a1</dd>
3206 <dt class="col-md-4">ellipse</dt><dd class="col-md-8"> x0,y0 rx,ry a0,a1</dd>
3207 <dt class="col-md-4">circle</dt><dd class="col-md-8"> x0,y0 x1,y1</dd>
3208 <dt class="col-md-4">polyline</dt><dd class="col-md-8"> x0,y0 ... xn,yn</dd>
3209 <dt class="col-md-4">polygon</dt><dd class="col-md-8"> x0,y0 ... xn,yn</dd>
3210 <dt class="col-md-4">bezier</dt><dd class="col-md-8"> x0,y0 ... xn,yn</dd>
3211 <dt class="col-md-4">path</dt><dd class="col-md-8">specification </dd>
3212 <dt class="col-md-4">image</dt><dd class="col-md-8"> operator x0,y0 w,h filename</dd>
3215 <p>The text primitive:</p>
3218 <dt class="col-md-4">text</dt><dd class="col-md-8">x0,y0 string</dd>
3220 <p>The text gravity primitive:</p>
3223 <dt class="col-md-4">gravity</dt><dd class="col-md-8">NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3226 <p>The text gravity primitive only affects the placement of text and does not
3227 interact with the other primitives. It is equivalent to using the <a
3228 href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
3229 scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3231 <p>The transformation primitives:</p>
3234 <dt class="col-md-4">rotate</dt><dd class="col-md-8">degrees</dd>
3235 <dt class="col-md-4">translate</dt><dd class="col-md-8">dx,dy</dd>
3236 <dt class="col-md-4">scale</dt><dd class="col-md-8">sx,sy</dd>
3237 <dt class="col-md-4">skewX</dt><dd class="col-md-8">degrees</dd>
3238 <dt class="col-md-4">skewY</dt><dd class="col-md-8">degrees</dd>
3241 <p>The pixel operation primitives:</p>
3244 <dt class="col-md-4">color</dt><dd class="col-md-8">x0,y0 method</dd>
3245 <dt class="col-md-4">matte</dt><dd class="col-md-8">x0,y0 method</dd>
3248 <p>The shape primitives are drawn in the color specified by the preceding <a
3249 href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3250 href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3251 "outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3252 href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
3254 <p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3255 pixel plane, that is, by an ordered pair of integer coordinates,
3256 <var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
3257 primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3258 href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
3260 <p>A <code>line</code> primitive requires a start point and end point.</p>
3262 <p>A <code>rectangle</code> primitive is specified by the pair of points at the
3263 upper left and lower right corners.</p>
3265 <p>A <code>roundRectangle</code> primitive takes the same corner points as
3266 a <code>rectangle</code> followed by the width and height of the rounded corners
3269 <p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3270 Give the center and any point on the perimeter (boundary).</p>
3272 <p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3273 to a given rectangle. An <code>arc</code> requires the two corners used for
3274 <code>rectangle</code> (see above) followed by the start and end angles of the
3275 arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3276 points produced are then joined with a line segment and the resulting segment
3277 of an ellipse is filled.</p>
3279 <p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3280 center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3281 the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
3284 <p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3285 more points to define their perimeters. A <code>polyline</code> is simply
3286 a <code>polygon</code> in which the final point is not stroked to the start
3287 point. When unfilled, this is a <var>polygonal line</var>. If the <a
3288 href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
3289 a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3291 <p>A <var>coordinate</var> is a pair of integers separated by a space or
3292 optional comma. </p>
3294 <p>As an example, to define a circle centered at 100,100 that extends to
3297 <pre class="highlight"><code>-draw 'circle 100,100 150,150'
3300 <p>The <code>Bezier</code> primitive creates a spline curve and requires three
3301 or points to define its shape. The first and last points are the
3302 <var>knots</var> and these points are attained by the curve, while any
3303 intermediate coordinates are <var>control points</var>. If two control points
3304 are specified, the line between each end knot and its sequentially respective
3305 control point determines the tangent direction of the curve at that end. If
3306 one control point is specified, the lines from the end knots to the one
3307 control point determines the tangent directions of the curve at each end. If
3308 more than two control points are specified, then the additional control points
3309 act in combination to determine the intermediate shape of the curve. In order
3310 to draw complex curves, it is highly recommended either to use the
3311 <code>path</code> primitive or to draw multiple four-point bezier segments with
3312 the start and end knots of each successive segment repeated. For example:</p>
3314 <pre class="highlight"><code>-draw 'bezier 20,50 45,100 45,0 70,50'
3315 -draw 'bezier 70,50 95,100 95,0 120,50'
3318 <p>A <code>path</code> represents an outline of an object, defined in terms of
3319 moveto (set a new current point), lineto (draw a straight line), curveto (draw
3320 a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3321 current shape by drawing a line to the last moveto) elements. Compound paths
3322 (i.e., a path with subpaths, each consisting of a single moveto followed by
3323 one or more line or curve operations) are possible to allow effects such as
3324 <var>donut holes</var> in objects. (See <a
3325 href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
3327 <p>Use <code>image</code> to composite an image with another image. Follow the
3328 image keyword with the composite operator, image location, image size, and
3331 <pre class="highlight"><code>-draw 'image SrcOver 100,100 225,225 image.jpg'
3334 <p>You can use 0,0 for the image size, which means to use the actual
3335 dimensions found in the image header. Otherwise, it is scaled to the given
3336 dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
3337 a detailed discussion of alpha composition methods that are available. </p>
3339 <p>The "special augmented compose operators" such as "dissolve" that require
3340 arguments cannot be used at present with the <code>-draw image</code> option.
3343 <p>Use <code>text</code> to annotate an image with text. Follow the text
3344 coordinates with a string. If the string has embedded spaces, enclose it in
3345 single or double quotes.</p>
3347 <p>For example, the following annotates the image with <code>Works like
3348 magick!</code> for an image titled <code>bird.miff</code>. </p>
3350 <pre class="highlight"><code>-draw "text 100,100 'Works like magick!' "
3353 <p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3354 to annotate an image with text.</p>
3356 <p>The <code>rotate</code> primitive rotates subsequent shape primitives and
3357 text primitives about the origin of the main image. If the <a
3358 href="command-line-options.html#region">-region</a> option precedes the <a href="command-line-options.html#draw">-draw</a>
3359 option, the origin for transformations is the upper left corner of the
3362 <p>The <code>translate</code> primitive translates subsequent shape and text
3365 <p>The <code>scale</code> primitive scales them.</p>
3367 <p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3368 to the origin of the main image or the region.</p>
3370 <p>The transformations modify the current affine matrix, which is initialized
3371 from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3372 option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3373 option. The initial affine matrix is not affected; that matrix is only changed
3374 by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3375 <a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3376 reinitialized from the initial affine matrix.</p>
3378 <p>Use the <code>color</code> primitive to change the color of a pixel to the
3379 fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3382 <pre class="highlight"><code>point
3389 <p>Consider the target pixel as that specified by your coordinate. The
3390 <code>point</code> method recolors the target pixel. The <code>replace</code>
3391 method recolors any pixel that matches the color of the target pixel.
3392 <code>Floodfill</code> recolors any pixel that matches the color of the target
3393 pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3394 pixel that is not the border color. Finally, <code>reset</code> recolors all
3397 <p>Use <code>matte</code> to the change the pixel matte value to transparent.
3398 Follow the pixel coordinate with a method (see the <code>color</code> primitive
3399 for a description of methods). The <code>point</code> method changes the matte
3400 value of the target pixel. The <code>replace</code> method changes the matte
3401 value of any pixel that matches the color of the target pixel.
3402 <code>Floodfill</code> changes the matte value of any pixel that matches the
3403 color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
3404 changes the matte value of any neighbor pixel that is not the border color (<a
3405 href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
3406 matte value of all pixels.</p>
3408 <p>You can set the primitive color, font, and font bounding box color with <a
3409 href="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>
3410 respectively. Options are processed in command line order so be sure to use
3411 these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3413 <p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3416 <p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
3417 Vector Graphics</a> format.</p>
3420 <div style="margin: auto;">
3421 <h3><a class="anchor" id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3424 <p class="magick-description">duplicate an image one or more times.</p>
3426 <p>Specify the count and the image to duplicate by its index in the sequence.
3427 The first image is index 0. Negative indexes are relative to the end of the
3428 sequence, for example, -1 represents the last image of the sequence. Specify
3429 a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
3430 0,2). Use <code>+duplicate</code> to duplicate the last image in the current
3433 <div style="margin: auto;">
3434 <h3><a class="anchor" id="edge"></a>-edge <var>radius</var></h3>
3437 <p class="magick-description">detect edges within an image.</p>
3439 <div style="margin: auto;">
3440 <h3><a class="anchor" id="emboss"></a>-emboss <var>radius</var></h3>
3443 <p class="magick-description">emboss an image.</p>
3445 <div style="margin: auto;">
3446 <h3><a class="anchor" id="encipher"></a>-encipher <var>filename</var></h3>
3449 <p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3451 <p>Get the passphrase from the file specified by <var>filename</var>.</p>
3453 <p>For more information, see the webpage, <a
3454 href="../www/cipher.html">ImageMagick: Encipher or
3455 Decipher an Image</a>.</p>
3459 <div style="margin: auto;">
3460 <h3><a class="anchor" id="encoding"></a>-encoding <var>type</var></h3>
3463 <p class="magick-description">specify the text encoding.</p>
3467 <pre class="highlight"><code>AdobeCustom AdobeExpert
3468 AdobeStandard AppleRoman
3475 <div style="margin: auto;">
3476 <h3><a class="anchor" id="endian"></a>-endian <var>type</var></h3>
3479 <p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3481 <p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3483 <p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3486 <div style="margin: auto;">
3487 <h3><a class="anchor" id="enhance"></a>-enhance</h3>
3490 <p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3493 <div style="margin: auto;">
3494 <h3><a class="anchor" id="equalize"></a>-equalize</h3>
3497 <p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3499 <p>To perform histogram equalization on all channels in concert, transform the
3500 image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3501 equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3503 <p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3504 -equalize -colorspace RGB</code> ...</p>
3506 <p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3507 components transformation that puts most of the information in the first
3508 channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3509 -colorspace RGB</code> ...</p>
3511 <div style="margin: auto;">
3512 <h3><a class="anchor" id="evaluate"></a>-evaluate <var>operator value</var></h3>
3515 <p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3517 <p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3518 multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
3519 elaborate calculations are needed.)</p>
3521 <p>The behaviors of each <var>operator</var> are summarized in the
3522 following list. For brevity, the numerical value of a "pixel" referred to
3523 below is the value of the corresponding channel of that pixel, while
3524 a "normalized pixel" is that number divided by the maximum
3525 (installation-dependent) value <var>QuantumRange</var>. (If
3526 normalized pixels are used, they are restored, following the other
3527 calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3529 <table class="table table-sm table-striped">
3534 <th><var>operator</var></th>
3535 <th>Summary (see further below for details)</th>
3540 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3541 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3542 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3543 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3544 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3545 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3546 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3547 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3548 <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>
3549 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3550 <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>
3551 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3552 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3553 <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>
3554 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3555 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3556 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3557 <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>
3558 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3559 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3560 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3561 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3562 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3563 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3565 <tr><td> </td><td> </td></tr>
3567 <tr><td>Gaussian-noise</td><td> </td></tr>
3568 <tr><td>Impulse-noise</td><td> </td></tr>
3569 <tr><td>Laplacian-noise</td><td> </td></tr>
3570 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="command-line-options.html#noise" >-noise</a> operators.)</td></tr>
3571 <tr><td>PoissonNoise</td><td> </td></tr>
3572 <tr><td>Uniform-noise</td><td> </td></tr>
3574 <tr><td> </td><td> </td></tr>
3576 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3577 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3578 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3582 <p>The specified functions are applied only to each previously set <a
3583 href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
3584 calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3585 represented as a 'alpha' values (0 = fully transparent), so, for example, a
3586 <code>Divide</code> by 2 of the alpha channel will make the image
3587 semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3588 as a percentage of the <var>QuantumRange</var>.</p>
3590 <p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3591 <a href="command-line-options.html#list">-list evaluate</a>.</p>
3593 <p>The results of the <code>Add</code>, <code>Subtract</code> and
3594 <code>Multiply</code> methods can also be achieved using either the <a
3595 href="command-line-options.html#level" >-level</a> or the <a href="command-line-options.html#level" >+level</a> operator, with
3596 appropriate argument, to linearly modify the overall range of color values.
3597 Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3598 'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
3601 <p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3602 addition modulo the <var>QuantumRange</var>. It is therefore
3603 equivalent to <code>Add</code> unless the resulting pixel value is outside the
3604 interval [0, <var>QuantumRange</var>]. </p>
3606 <p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3607 works on normalized pixel values. The <var>value</var> used with
3608 <code>Exp</code> should be negative so as to produce a decaying exponential
3609 function. Non-negative values will always produce results larger unity and
3610 thus outside the interval [0, <var>QuantumRange</var>]. The
3611 formula is expressed below. </p>
3613 <p class="text-center">
3614 exp(<var>value</var> × <b><var>u</var></b>)
3617 <p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3618 >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
3621 <p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3622 normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3623 factor</var> that adjusts the curvature in the graph of the log function. The
3624 formula applied to a normalized value <b><var>u</var></b> is below. </p>
3626 <p class="text-center">
3627 log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3630 <p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
3631 normalized pixel values. Note that <code>Pow</code> is related to the <a
3632 href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
3633 to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
3634 with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
3635 with <code>Pow</code>.</p>
3637 <p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3638 converts the image values into a value according to a (co)sine wave function.
3639 The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3640 is biased 50% and normalized by 50% so as to fit in the respective color value
3641 range. The <var>value</var> scaling of the <var>period</var> of the
3642 function (its frequency), and thus determines the number of 'waves' that will
3643 be 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,
3644 then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3646 <p class="text-center">
3647 0.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3650 <p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
3651 multi-value version of evaluate. </p>
3653 <div style="margin: auto;">
3654 <h3><a class="anchor" id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3657 <p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression over a sequence of images. Ensure all the images in the sequence are in the same colorspace, otherwise you may get unexpected results, e.g. add <a href="command-line-options.html#colorspace" >-colorspace sRGB</a> to your command-line.</p>
3659 <p>To print a complete list of <a
3660 href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3661 href="command-line-options.html#list">-list evaluate</a>.</p>
3663 <div style="margin: auto;">
3664 <h3><a class="anchor" id="extent"></a>-extent <var>geometry</var></h3>
3667 <p class="magick-description">Set the image size and offset.</p>
3669 <p>If the image is enlarged, unfilled areas are set to the background color.
3670 To position the image, use offsets in the <var>geometry</var>
3671 specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
3672 specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3675 <p>This command reduces or expands a JPEG image to fit on an 800x600
3676 display. If the aspect ratio of the input image isn't exactly 4:3, then the
3677 image is centered on an 800x600 black canvas: </p>
3679 <pre class="highlight"><code>convert input.jpg -resize 800x600 -background black -compose Copy \
3680 -gravity center -extent 800x600 -quality 92 output.jpg
3683 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3685 <div style="margin: auto;">
3686 <h3><a class="anchor" id="extract"></a>-extract <var>geometry</var></h3>
3689 <p class="magick-description">Extract the specified area from image.</p>
3691 <p>This option is most useful for extracting a subregion of a very large raw
3692 image. Note that these two commands are equivalent:</p>
3694 <pre class="highlight"><code>convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3695 image.rgb image.png",
3696 convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3697 image.rgb image.png"
3700 <p>If you omit the offsets, as in</p>
3702 <pre class="highlight"><code>convert -size 16000x16000 -depth 8 -extract 640x480 \
3706 <p>the image is <var>resized</var> to the specified dimensions instead,
3709 <pre class="highlight"><code>convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3712 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3714 <div style="margin: auto;">
3715 <h3><a class="anchor" id="family"></a>-family <var>fontFamily</var></h3>
3718 <p class="magick-description">Set a font family for text.</p>
3720 <p>This setting suggests a font family that ImageMagick should try to use for
3721 rendering text. If the family can be found it is used; if not, a default font
3722 (e.g., "Arial") or a family known to be similar is substituted (e.g.,
3723 "Courier" might be used if "System" is requested but not found). </p>
3725 <p>For other settings that affect fonts, see the options <a
3726 href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3727 href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
3729 <div style="margin: auto;">
3730 <h3><a class="anchor" id="features"></a>-features <var>distance</var></h3>
3733 <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>
3735 <pre class="highlight"><code>Angular Second Moment Sum Entropy
3737 Correlation Difference Variance
3738 Sum of Squares Variance Difference Entropy
3739 Inverse Difference Moment Information Measure of Correlation 1
3740 Sum Average Information Measure of Correlation 2
3741 Sum Variance Maximum Correlation Coefficient
3744 <div style="margin: auto;">
3745 <h3><a class="anchor" id="fft"></a>-fft</h3>
3748 <p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3750 <p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3751 users in ImageMagick 6.6.0-9). It transforms an image from the normal
3752 (spatial) domain to the frequency domain. In the frequency domain, an image is
3753 represented as a superposition of complex sinusoidal waves of varying
3754 amplitudes. The image x and y coordinates are the possible frequencies along
3755 the x and y directions, respectively, and the pixel intensity values are
3756 complex numbers that correspond to the sinusoidal wave amplitudes. See for
3757 example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3758 Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3759 Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3762 <p>A single image name is provided as output for this option. However, the
3763 output result will have two components. It is either a two-frame image or two
3764 separate images, depending upon whether the image format specified supports
3765 multi-frame images. The reason that we get a dual output result is because the
3766 frequency domain represents an image using complex numbers, which cannot be
3767 visualized directly. Therefore, the complex values are automagically separated
3768 into a two-component image representation. The first component is the
3769 magnitude of the complex number and the second is the phase of the complex
3770 number. See for example, <a
3771 href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
3773 <p>The magnitude and phase component images must be specified using image
3774 formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3775 PFM, EXR and PNG are the recommended image formats to use. All of these
3776 formats, except PNG support multi-frame images. So for example,</p>
3778 <pre class="highlight"><code>convert image.png -fft fft_image.miff
3781 <p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3782 image as <code>fft_image.miff[1]</code>. Similarly,</p>
3784 <pre class="highlight"><code>convert image.png -fft fft_image.png
3787 <p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3788 as <code>fft_image-1.png</code>. If you prefer this representation, then you can
3789 force any of the other formats to produce two output images by including <a
3790 href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
3792 <p>The input image can be any size, but if not square and even-dimensioned, it
3793 is padded automagically to the larger of the width or height of the input
3794 image and to an even number of pixels. The padding will occur at the bottom
3795 and/or right sides of the input image. The resulting output magnitude and
3796 phase images is square at this size. The kind of padding relies on the <a
3797 href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
3799 <p>Both output components will have dynamic ranges that fit within
3800 [0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3801 Phase values nominally range from 0 to 2*π, but is scaled to span the full
3802 dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3803 scaled). The magnitude image is not scaled and thus generally will contain
3804 very small values. As such, the image normally will appear totally black. In
3805 order to view any detail, the magnitude image typically is enhanced with a log
3806 function into what is usually called the spectrum. A log function is used to
3807 enhance the darker values more in comparison to the lighter values. This can
3808 be done, for example, as follows:</p>
3810 <pre class="highlight"><code>convert fft_image.miff[0] -contrast-stretch 0 \
3811 -evaluate log 1000 fft_image_spectrum.png"
3814 <p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3815 href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
3816 range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3817 typically is specified between 100 and 10,000, depending upon the amount of
3818 detail that one wants to bring out in the spectrum. Larger values produce more
3819 visible detail. Too much detail, however, may hide the important features.</p>
3821 <p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3822 use <a href="command-line-options.html#fft">-fft</a>.</p>
3824 <p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3825 and imaginary components of the complex valued Fourier transform.</p>
3827 <p>However, as the real and imaginary components can contain negative values,
3828 this requires that IM be configured with HDRI enabled. In this case, you must
3829 use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3830 results, since they are formats that preserve both negative and fractional
3831 values without clipping them or truncating the fractional part. With either
3832 MIFF or TIF, one should add -define quantum:format=32, to allow those image
3833 types to work properly in HDRI mode without clipping.</p>
3835 <p>The real and imaginary component images resulting from <a
3836 href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
3837 padding that was discussed above for the magnitude and phase component
3840 <p>See the discussion on HDRI implementations of ImageMagick on the page <a
3841 href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3842 about HDRI go the ImageMagick <a
3843 href="../Usage/basics/#hdri" >Usage</a> pages, <a
3844 href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3845 >Fred's Fourier Processing With ImageMagick page</a> or this <a
3846 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
3849 <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>
3852 <div style="margin: auto;">
3853 <h3><a class="anchor" id="fill"></a>-fill <var>color</var></h3>
3856 <p class="magick-description">color to use when filling a graphic primitive.</p>
3858 <p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
3859 HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
3860 a description of how to properly specify the color argument.</p>
3862 <p>Enclose the color specification in quotation marks to prevent the "#" or
3863 the parentheses from being interpreted by your shell.</p>
3867 <pre class="highlight"><code>-fill blue
3869 -fill "rgb(255,255,255)"
3872 <p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3874 <p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3876 <div style="margin: auto;">
3877 <h3><a class="anchor" id="filter"></a>-filter <var>type</var></h3>
3880 <p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3882 <p>Use this option to affect the resizing operation of an image during
3883 operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3884 >-distort</a>. For example you can use a simple resize filter such as:</p>
3886 <pre class="highlight"><code>Point Hermite Cubic
3888 Triangle Quadratic Mitchell
3892 <p>Use <code>-define filter:lobes={2,3,4}</code> to specify the support size for filtering for the <code>CubicSpline</code> filter.</p>
3894 <p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3895 as a faster <code>SincFast</code> equivalent form). However these filters are
3896 generally useless on their own as they are infinite filters that are being
3897 clipped to the filters support size. Their direct use is not recommended
3898 except via expert settings (see below). </p>
3900 <p>Instead these special filter functions are typically windowed by a windowing
3901 function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
3902 using these functions will define a 'Windowed' filter, appropriate to the
3903 operator involved. Windowed filters include: </p>
3905 <pre class="highlight"><code>Lanczos Hamming Parzen
3906 Blackman Kaiser Welsh
3907 Hanning Bartlett Bohman
3910 <p>Also one special self-windowing filter is also provided
3911 <code>Lagrange</code>, which will automagically re-adjust its function depending
3912 on the current 'support' or 'lobes' expert settings (see below).</p>
3914 <p>If you do not select a filter with this option, the filter defaults to
3915 <code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3916 if the image is enlarged. Otherwise the filter default to
3917 <code>Lanczos</code>.</p>
3919 <p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3920 filter</a> option.</p>
3922 <p>You can modify how the filter behaves as it scales your image through the
3923 use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3924 href="command-line-options.html#set" >-set</a>):-</p>
3926 <table class="table table-sm table-striped">
3928 <td>-define filter:blur=<var>factor</var></td>
3929 <td>Scale the X axis of the filter (and its window). Use > 1.0 for
3930 blurry or < 1.0 for sharp. This should only be used with Gaussian and
3931 Gaussian-like filters simple filters, or you may not get the expected
3936 <td>-define filter:support=<var>radius</var></td>
3937 <td>Set the filter support radius. Defines how large the filter should be and
3938 thus directly defines how slow the filtered resampling process is. All
3939 filters have a default 'preferred' support size. Some filters like
3940 <code>Lagrange</code> and windowed filters adjust themselves depending on
3941 this value. With simple filters this value either does nothing (but slow
3942 the resampling), or will clip the filter function in a detrimental way.
3947 <td>-define filter:lobes=<var>count</var></td>
3948 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3949 alternative way of specifying the 'support' range of the filter, that is
3950 designed to be more suited to windowed filters, especially when used for
3951 image distorts.</td>
3955 <td>-define filter:sigma=<var>value</var></td>
3956 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3957 sigma value is '<code>0.5</code>'. It only affects <code>Gaussian</code> but
3958 does not shrink (but may enlarge) the filter's 'support'. It can be used
3959 to generate very small blurs but without the filter 'missing' pixels due
3960 to using a small support setting. A larger value of '<code>0.707</code>'
3961 (a value of '1/sqrt(2)') is another common setting. </td>
3965 <td>-define filter:b=<var>b-spline_factor</var></td>
3969 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3970 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3971 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3972 the <code>Parzen</code> cubic windowing function. If only one of the values
3973 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3974 The values meaning was defined by a research paper by
3975 Mitchell-Netravali.</td>
3979 <td>-define filter:kaiser-beta=<var>value</var></td>
3980 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3981 Default value is '6.5'. It only affects Kaiser windowing function, and
3982 does not affect any other attributes.
3983 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3984 inheritance from the very old "zoom" program). It was changed to bring the
3985 function in line with more modern academic research usage, and better
3986 assign it be more definitive. </td>
3990 <td>-define filter:kaiser-alpha=<var>value</var></td>
3991 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3992 will override that setting. It only affects Kaiser windowing function,
3993 and does not affect any other attributes. </td>
3997 <td>-define filter:filter=<var>filter_function</var></td>
3998 <td>Use this function directly as the weighting filter. This will allow
3999 you to directly use a windowing function such as <code>Blackman</code>,
4000 as a resampling filter, rather than as its normal usage as a windowing
4001 function. If defined, no windowing function also defined, the window function is set
4002 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
4003 as a filter will also do this. </td>
4007 <td>-define filter:window=<var>filter_function</var></td>
4008 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
4009 <code>Jinc</code> are windowed (brought down to zero over the defined
4010 support range) with the given filter. This allows you to specify a filter
4011 function to be used as a windowing function for these IIR filters.
4012 Many of the defined filters are actually windowing functions for these IIR
4013 filters. A typical choices is <code>Box</code>, (which effectively turns
4014 off the windowing function). </td>
4018 <td>-define filter:win-support=<var>radius</var></td>
4019 <td>Scale windowing function to this size instead. This causes the windowing
4020 (or self-windowing Lagrange filter) to act is if the support window is
4021 larger than what is actually supplied to the calling operator. The filter
4022 however is still clipped to the real support size given. If unset this
4023 will equal the normal filter support size. </td>
4027 <td>-define filter:verbose=<var>1</var></td>
4028 <td>This causes IM to print information on the final internal filter
4029 selection to standard output. This includes a commented header on the
4030 filter settings being used, and data allowing the filter weights to be
4031 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
4032 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
4033 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
4034 with specific 'B' and 'C' settings. </td>
4039 <p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
4041 <pre class="highlight"><code>convert image.png \
4043 -set filter:window=jinc \
4044 -set filter:lobes=8 \
4045 -resize 150% image.jpg"
4048 <p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
4050 <pre class="highlight"><code>convert image.png \
4051 -set filter:filter=sinc \
4052 -set filter:lobes=4 \
4053 -resize 150% image.jpg"
4056 <p>To extract the data for a raw windowing function, combine it with
4057 a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
4058 windowing function. </p>
4060 <pre class="highlight"><code>convert null: -define filter:filter=Box \
4061 -define filter:window=Welch \
4062 -define filter:support=1.0 \
4063 -define filter:verbose=1 \
4064 -resize 2 null: > window_welch.dat
4067 plot \"window_welch.dat\" with lines
4070 <p>Note that the use of expert options is provided for image processing experts
4071 who have studied and understand how resize filters work. Without this
4072 knowledge, and an understanding of the definition of the actual filters
4073 involved, using expert settings are more likely to be detrimental to your image
4077 <div style="margin: auto;">
4078 <h3><a class="anchor" id="flatten"></a>-flatten</h3>
4081 <p class="magick-description">This is a simple alias for the <a href="command-line-options.html#layers" >-layers</a> method "flatten".</p>
4084 <div style="margin: auto;">
4085 <h3><a class="anchor" id="flip"></a>-flip</h3>
4088 <p class="magick-description">create a <var>mirror image</var></p>
4090 <p>reflect the scanlines in the vertical direction. The image will be mirrored
4094 <div style="margin: auto;">
4095 <h3><a class="anchor" id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
4098 <p class="magick-description">floodfill the image with color at the specified offset.</p>
4100 <p>Flood fill starts from the given 'seed point' which is not gravity affected.
4101 Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
4102 given <var>color</var> argument, connected to that 'seed point'
4103 will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
4105 <p>Note that if the pixel at the 'seed point' does not itself match the given
4106 <var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
4107 action will be taken. </p>
4109 <p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
4110 a more general flood fill that reads the matching color directly at the 'seed
4111 point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
4112 its 'color floodfill' drawing method. </p>
4115 <div style="margin: auto;">
4116 <h3><a class="anchor" id="flop"></a>-flop</h3>
4119 <p class="magick-description">create a <var>mirror image</var>.</p>
4121 <p>Reflect the scanlines in the horizontal direction, just like the image in
4122 a vertical mirror. </p>
4125 <div style="margin: auto;">
4126 <h3><a class="anchor" id="font"></a>-font <var>name</var></h3>
4129 <p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4131 <p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4132 option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4134 <p>In addition to the fonts specified by the above pre-defined list, you can
4135 also specify a font from a specific source. For example <code>Arial.ttf</code>
4136 is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4137 <code>x:fixed</code> is X11 font.</p>
4139 <p>For other settings that affect fonts, see the options <a
4140 href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4141 href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
4144 <div style="margin: auto;">
4145 <h3><a class="anchor" id="foreground"></a>-foreground <var>color</var></h3>
4148 <p class="magick-description">Define the foreground color for menus.", "display</p>
4150 <p>The color is specified using the format described under the <a
4151 href="command-line-options.html#fill">-fill</a> option.</p>
4153 <p>The default foreground color is black.</p>
4155 <div style="margin: auto;">
4156 <h3><a class="anchor" id="format"></a>-format <var>type</var></h3>
4159 <p class="magick-description">the image format type.</p>
4161 <p>When used with the <code>mogrify</code> utility, this option converts any
4162 image to the image <a href="formats.html">format</a> you specify.
4163 For a list of image format types supported by ImageMagick, use <a
4164 href="command-line-options.html#list">-list format</a>.</p>
4166 <p>By default the file is written to its original name. However, if the
4167 filename extension matches a supported format, the extension is replaced with
4168 the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4169 example, if you specify <var>tiff</var> as the format type and the
4170 input image filename is <var>image.gif</var>, the output image
4171 filename becomes <var>image.tiff</var>.</p>
4173 <div style="margin: auto;">
4174 <h3><a class="anchor" id="format_identify_"></a>-format <var>string</var></h3>
4177 <p class="magick-description">output formatted image characteristics.</p>
4179 <p>See <a href="escape.html">Format and Print Image
4180 Properties</a> for an explanation on how to specify the argument to this
4183 <div style="margin: auto;">
4184 <h3><a class="anchor" id="frame"></a>-frame <var>geometry</var></h3>
4187 <p class="magick-description">Surround the image with a border or beveled frame.</p>
4189 <p>The color of the border is specified with the <a href="command-line-options.html#mattecolor"
4190 >-mattecolor</a> command line option. </p>
4192 <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
4193 height that is added to the dimensions of the image. If no offsets are given
4194 in the <var>geometry</var> argument, then the border added is
4195 a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4196 the width and height of the border is partitioned to form an outer bevel of
4197 thickness <var>x</var> pixels and an inner bevel of thickness
4198 <var>y</var> pixels. Negative offsets make no sense as frame arguments.
4201 <p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4202 href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
4203 '<code>Over</code>' composition method. It generates an image of the appropriate
4204 size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
4205 draws the frame of four distinct colors close to the current <a
4206 href="command-line-options.html#mattecolor">-mattecolor</a>. The original image is then overlaid onto
4207 center of this image. This means that with the default compose method of
4208 '<code>Over</code>' any transparent parts may be replaced by the current <a
4209 href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
4211 <p>The image composition is not
4212 affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4215 <div style="margin: auto;">
4216 <h3><a class="anchor" id="frame_import_"></a>-frame</h3>
4219 <p class="magick-description">include the X window frame in the imported image. </p>
4220 <div style="margin: auto;">
4221 <h3><a class="anchor" id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4224 <p class="magick-description">Apply a function to channel values.</p>
4226 <p>This operator performs calculations based on the given arguments to modify
4227 each of the color values for each previously set <a
4228 href="command-line-options.html#channel">-channel</a> in the image. See <a
4229 href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
4230 calculations are handled.</p>
4232 <p>This is can be considered a multi-argument version of the <a
4233 href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
4234 ImageMagick 6.4.8−8.)</p>
4236 <p>Here, <var>parameters</var> is a comma-separated list of
4237 numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4239 <pre class="highlight"><code>Polynomial
4245 <p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4246 use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4249 <dt class="col-md-4">Polynomial</dt>
4250 <dd class="col-md-8"><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4251 these being the coefficients of a polynomial, in decreasing order of degree.
4252 That is, entering</p>
4254 <pre class="highlight"><code>-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>
4257 <p>will invoke a polynomial function given by</p>
4259 <pre class="highlight"><code><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>,
4262 <p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4264 <p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4265 (the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4266 <code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
4267 polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4268 href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
4269 correspondences follow.</p>
4271 <table class="table table-sm table-striped">
4273 <td>-evaluate Set <var>value</var> </td>
4274 <td>-function Polynomial <var>value</var></td>
4275 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4278 <td>-evaluate Add <var>value</var> </td>
4279 <td>-function Polynomial 1,<var>value</var></td>
4282 <td>-evaluate Subtract <var>value</var> </td>
4283 <td>-function Polynomial 1,−<var>value</var></td>
4286 <td>-evaluate Multiply <var>value</var> </td>
4287 <td>-function Polynomial <var>value</var>,0</td>
4290 <td>+level black% x white%</td>
4291 <td>-function Polynomial A,B</td>
4292 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4296 <p>The <code>Polynomial</code> function gives great versatility, since
4297 polynomials can be used to fit any continuous curve to any degree of accuracy
4301 <dt class="col-md-4">Sinusoid</dt>
4302 <dd class="col-md-8">
4303 <p>The <code>Sinusoid</code> function can be used to vary the channel values
4304 sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4305 values are given as one to four parameters, as follows,</p>
4307 <pre class="highlight"><code>-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4310 <p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4311 corresponds to 0 through <var>freq</var>×360 degrees.)
4312 The result is that if a pixel's normalized channel value is originally
4313 <b><var>u</var></b>, its resulting normalized value is given by </p>
4315 <pre class="highlight"><code><var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4318 <p> For example, the following generates a curve that starts and ends at 0.9
4319 (when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4320 .7−.2=.5 and .7+.2=.9. </p>
4322 <pre class="highlight"><code>-function Sinusoid 3,-90,.2,.7
4325 <p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4328 <p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4329 <code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4330 varying amplitude, phase and bias. The correspondence is as follows.</p>
4332 <table class="table table-sm table-striped">
4334 <td>-evaluate Sin <var>freq</var> </td>
4335 <td>-function Sinusoid <var>freq</var>,0 </td>
4338 <td>-evaluate Cos <var>freq</var> </td>
4339 <td>-function Sinusoid <var>freq</var>,90 </td>
4343 <dt class="col-md-4">ArcSin</dt>
4344 <dd class="col-md-8">
4345 <p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4346 and can be used to generate cylindrical distortion and displacement maps.
4347 The curve can be adjusted relative to both the input values and output range
4350 <pre class="highlight"><code>-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4353 <p>with all values given in terms of normalized color values (0.0 for black,
4354 1.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4355 for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4357 <pre class="highlight"><code><var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4361 <dt class="col-md-4">ArcTan</dt>
4362 <dd class="col-md-8">
4363 <p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4364 limit values at infinities, though a center using the given slope value.
4365 All these values can be adjusted via the arguments.</p>
4367 <pre class="highlight"><code>-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4370 <p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4373 <pre class="highlight"><code><var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4380 <div style="margin: auto;">
4381 <h3><a class="anchor" id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4384 <p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4386 <p>A number of algorithms search for a target color. By default the color must
4387 be exact. Use this option to match colors that are close to the target color
4388 in RGB space. For example, if you want to automagically trim the edges of an
4389 image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4390 background color may differ by a small amount. This option can account for
4391 these differences.</p>
4393 <p>The <var>distance</var> can be in absolute intensity units or, by
4394 appending <code>%</code> as a percentage of the maximum possible intensity (255,
4395 65535, or 4294967295).</p>
4397 <p>Use <a href="command-line-options.html#fuzz" >+fuzz</a> to reset the fuzz value to 0.</p>
4400 <div style="margin: auto;">
4401 <h3><a class="anchor" id="fx"></a>-fx <var>expression</var></h3>
4404 <p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4406 <p>If the first character of <var>expression</var> is <code>@</code>,
4407 the expression is read from a file titled by the remaining characters in the
4410 <p>See <a href="fx.html">FX,
4411 The Special Effects Image Operator</a> for a detailed discussion of this
4415 <div style="margin: auto;">
4416 <h3><a class="anchor" id="gamma"></a>-gamma <var>value</var></h3>
4419 <p class="magick-description">level of gamma correction.</p>
4421 <p>The same color image displayed on two different workstations may look
4422 different due to differences in the display monitor. Use gamma correction to
4423 adjust for this color difference. Reasonable values extend from
4424 <code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4425 gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4426 result in the loss of some image information if the pixel quantum size is only
4427 eight bits (quantum range 0 to 255).</p>
4429 <p>Gamma adjusts the image's channel values pixel-by-pixel according to
4430 a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4431 normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4432 same as taking the square root of the image.</p>
4434 <p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4435 image gamma level without actually adjusting the image pixels. This option
4436 is useful if the image is of a known gamma but not set as an image attribute
4437 (e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4438 display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4441 <pre class="highlight"><code>convert input.png +gamma .45455 output.png
4444 <p>(0.45455 is 1/2.2)</p>
4446 <p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4448 <div style="margin: auto;">
4449 <h3><a class="anchor" id="gaussian-blur"></a>-gaussian-blur <var>radius</var><br />-gaussian-blur <var>radius</var>x<var>sigma</var></h3>
4452 <p class="magick-description">Blur the image with a Gaussian operator.</p>
4454 <p>Convolve the image with a Gaussian or normal distribution using the given
4455 <var >Sigma</var> value. The formula is:</p>
4457 <p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/> </p>
4459 <p>The <var >Sigma</var> value is the important argument, and
4460 determines the actual amount of blurring that will take place. </p>
4462 <p>The <var >Radius</var> is only used to determine the size of the
4463 array which will hold the calculated Gaussian distribution. It should be an
4464 integer. If not given, or set to zero, IM will calculate the largest possible
4465 radius that will provide meaningful results for the Gaussian distribution.
4468 <p>The larger the <var >Radius</var> the radius the slower the
4469 operation is. However too small a <var >Radius</var>, and severe
4470 aliasing effects may result. As a guideline, <var >Radius</var>
4471 should be at least twice the <var >Sigma</var> value, though three
4472 times will produce a more accurate result. </p>
4474 <p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4475 full 2-dimensional convolution is used to generate the weighted average of the
4476 neighboring pixels. </p>
4478 <p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4479 pixels which are outside the image proper are blurred into the final result.
4483 <div style="margin: auto;">
4484 <h3><a class="anchor" id="geometry"></a>-geometry <var>geometry</var></h3>
4487 <p class="magick-description">Set the preferred size and location of the image.</p>
4489 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4491 <div style="margin: auto;">
4492 <h3><a class="anchor" id="gravity"></a>-gravity <var>type</var></h3>
4495 <p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4497 <p>Choices include: <code>NorthWest</code>, <code>North</code>,
4498 <code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
4499 <code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4500 href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4501 href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
4504 <p>The direction you choose specifies where to position text or subimages. For
4505 example, a gravity of <code>Center</code> forces the text to be centered within
4506 the image. By default, the image gravity is <code>undefined</code>. See <a
4507 href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4508 text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4509 href="command-line-options.html#gravity">-gravity</a> option.</p>
4511 <p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4512 <a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
4513 take <var>geometry</var> as an argument, such as the <a
4514 href="command-line-options.html#crop">-crop</a> option. </p>
4516 <p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4517 or setting having a <var>geometry</var> argument that specifies an
4518 offset, the offset is usually applied to the point within the image suggested
4519 by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4520 command, for example, suppose the file <code>image.png</code> has dimensions
4521 200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4522 is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4523 <code>Center</code>, which suggests the midpoint of the image, at the point
4524 (100,50). The offset (−40,20) is applied to that point, giving
4525 (100−40,50+20)=(60,70), so the specified 10x10 region is located at
4526 that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4527 region itself, which is <var>centered</var> at the pixel
4528 coordinate (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>
4530 <pre class="highlight"><code>convert image.png -gravity Center -region 10x10-40+20 \
4534 <p>When used as an option to <a href="composite.html">composite</a>, <a
4535 href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
4536 within the composite.</p>
4538 <p>When used as an option to <a href="montage.html">montage</a>, <a
4539 href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
4540 within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4543 <div style="margin: auto;">
4544 <h3><a class="anchor" id="grayscale"></a>-grayscale <var>method</var></h3>
4547 <p class="magick-description">convert image to grayscale.</p>
4549 <p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
4550 convert the given image into a grayscale image. </p>
4552 <p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4554 <pre class="highlight"><code>convert in.png -grayscale Rec709Luminance out.png
4557 <p>which is equivalent to:</p>
4559 <pre class="highlight">
4560 <code>convert in.png -colorspace RGB -colorspace Gray out.png</code>
4562 <code>convert in.png -colorspace LinearGray out.png</code>
4565 <p>Note that LinearGray is new as of Imagemagick 6.9.9-29 and 7.0.7-17.</p>
4567 <p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4569 <pre class="highlight"><code>convert in.png -grayscale Rec709Luma out.png
4572 <p>which is equivalent to:</p>
4574 <pre class="highlight"><code>convert in.png -colorspace Gray out.png
4577 <p>Note that a 'colorspace' intensity method will produce the same result
4578 regardless of the current colorpsace of the image. But a 'mathematical'
4579 intensity method depends on the current colorspace the image is currently
4582 <p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4583 it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
4584 will not affect other operations that may use that setting.</p>
4587 <div style="margin: auto;">
4588 <h3><a class="anchor" id="green-primary"></a>-green-primary <var>x,y</var></h3>
4591 <p class="magick-description">green chromaticity primary point.</p>
4594 <div style="margin: auto;">
4595 <h3><a class="anchor" id="hald-clut"></a>-hald-clut</h3>
4598 <p class="magick-description">apply a Hald color lookup table to the image.</p>
4600 <p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4601 dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4602 can apply any color transformation to the Hald image and then use this option
4603 to apply the transform to the image. </p>
4605 <pre class="highlight"><code>convert image.png hald.png -hald-clut transform.png
4608 <p>This option provides a convenient method for you to use Gimp or Photoshop
4609 to make color corrections to the Hald CLUT image and subsequently apply them
4610 to multiple images using an ImageMagick script. </p>
4612 <p>Note that the representation is only of the normal RGB color space and that
4613 the whole color value triplet is used for the interpolated lookup of the
4614 represented Hald color cube image. Because of this the operation is not <a
4615 href="command-line-options.html#channel" >-channel</a> setting affected, nor can it adjust or modify an
4616 images transparency or alpha/matte channel.</p>
4618 <p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
4619 of the individual color channels, usually involving a simpler grayscale
4620 image. E.g: grayscale to color replacement, or modification by a histogram
4624 <div style="margin: auto;">
4625 <h3><a class="anchor" id="help"></a>-help</h3>
4628 <p class="magick-description">print usage instructions.</p>
4630 <div style="margin: auto;">
4631 <h3><a class="anchor" id="highlight-color"></a>-highlight-color <var>color</var></h3>
4634 <p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4636 <div style="margin: auto;">
4637 <h3><a class="anchor" id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4640 <p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4642 <p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4644 <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>.
4646 <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>
4648 <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>
4650 <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>
4652 <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>
4654 <p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4656 <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>
4658 <div style="margin: auto;">
4659 <h3><a class="anchor" id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4662 <p class="magick-description">specify the icon geometry.</p>
4664 <p>Offsets, if present in the geometry specification, are handled in the same
4665 manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4666 handle negative offsets.</p>
4668 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4670 <div style="margin: auto;">
4671 <h3><a class="anchor" id="iconic"></a>-iconic</h3>
4674 <p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4676 <div style="margin: auto;">
4677 <h3><a class="anchor" id="identify"></a>-identify</h3>
4680 <p class="magick-description">identify the format and characteristics of the image.</p>
4682 <p>This information is printed: image scene number; image name; image size;
4683 the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4684 number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4685 a description of the image class.</p>
4687 <p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
4688 in the image and color reduction error values are printed. Refer to <a
4689 href="../www/quantize.html">color
4690 reduction algorithm</a> for a description of these values.</p>
4692 <p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4693 amounts of image properties are displayed including image statistics, profiles,
4694 image histogram, and others.</p>
4696 <div style="margin: auto;">
4697 <h3><a class="anchor" id="ift"></a>-ift</h3>
4700 <p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4702 <p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4703 users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4704 images from the frequency domain to a single image in the normal or spatial
4705 domain. See for example, <a
4706 href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
4707 <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4708 <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4710 <p>For example, depending upon the image format used to store the result of
4711 the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4713 <pre class="highlight"><code>convert fft_image.miff -ift fft_image_ift.png
4718 <pre class="highlight"><code>convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4721 <p>The resulting image may need to be cropped due to padding introduced when
4722 the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4723 href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
4724 the right and/or bottom sides of the image.</p>
4726 <p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4727 use <a href="command-line-options.html#ift">-ift</a>.</p>
4729 <p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4730 and imaginary images from the frequency domain to a single image in the normal
4731 (spatial) domain.</p>
4733 <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>
4735 <div style="margin: auto;">
4736 <h3><a class="anchor" id="immutable"></a>-immutable</h3>
4739 <p class="magick-description">make image immutable.</p>
4741 <div style="margin: auto;">
4742 <h3><a class="anchor" id="implode"></a>-implode <var>factor</var></h3>
4745 <p class="magick-description">implode image pixels about the center.</p>
4747 <div style="margin: auto;">
4748 <h3><a class="anchor" id="insert"></a>-insert <var>index</var></h3>
4751 <p class="magick-description">insert the last image into the image sequence.</p>
4753 <p>This option takes last image in the current image sequence and inserts it
4754 at the given index. If a negative index is used, the insert position is
4755 calculated before the last image is removed from the sequence. As such
4756 <code>-insert -1</code> will result in no change to the image sequence.</p>
4758 <p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4759 other words, insert the last image, at the end of the current image sequence.
4760 Consequently this has no effect on the image sequence order.</p>
4762 <div style="margin: auto;">
4763 <h3><a class="anchor" id="intensity"></a>-intensity <var>method</var></h3>
4766 <p class="magick-description">method to generate intensity value from pixel.</p>
4768 <p>ImageMagick provides a number of methods used in situations where an
4769 operator needs to determine a single grayscale value for some purpose, from
4770 an image with red, green, and blue pixel components. Typically the
4771 <code>Rec709Luma</code> formula is used, which is the same formula used when converting images to <code>-colorspace gray</code>. </p>
4773 <p>The following formulas are currently provided, and will first convert
4774 the pixel values to linear-RGB or non-linear sRGB colorspace before
4775 being applied to calculate the final greyscale value. </p>
4778 <dt class="col-md-4">Rec601Luma</dt><dd class="col-md-8"> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4779 <dt class="col-md-4">Rec601Luminance</dt><dd class="col-md-8"> 0.298839R + 0.586811G + 0.114350B</dd>
4780 <dt class="col-md-4">Rec709Luma</dt><dd class="col-md-8"> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4781 <dt class="col-md-4">Rec709Luminance</dt><dd class="col-md-8"> 0.212656R + 0.715158G + 0.072186B</dd>
4782 <dt class="col-md-4">Brightness</dt><dd class="col-md-8"> max(R', G', B')</dd>
4783 <dt class="col-md-4">Lightness</dt><dd class="col-md-8"> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4786 <p>Note that the above R,G,B values is the image's linear-RGB values, while
4787 R',G',B' are sRGB non-linear values. </p>
4789 <p>These intensity methods are mathematical in nature and will use the
4790 current value in the images respective R,G,B channel regardless of
4791 what that is, or what colorspace the image is currently using.</p>
4794 <dt class="col-md-4">Average</dt><dd class="col-md-8">(R' + G' + B') / 3.0</dd>
4795 <dt class="col-md-4">MS</dt><dd class="col-md-8">(R'^2 + G'^2 + B'^2) / 3.0</dd>
4796 <dt class="col-md-4">RMS</dt><dd class="col-md-8">sqrt( (R'^2 + G'^2 + B'^2) / 3.0 )</dd>
4799 <p>These methods are often used for other purposes, such as generating a
4800 grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4801 >-compose</a> '<code>Difference</code>' composition. </p>
4803 <p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4804 error comparisions. While... The method 'RMS' (Root Mean Squared) for
4805 example is appropriate for calculating color vector distance, from a color
4806 difference image. This is equivalent to the color only component of the <a
4807 href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
4809 <p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4810 grayscaling formula directly to an image without setting the <a
4811 href="command-line-options.html#intensity" >-intensity</a> setting.</p>
4813 <p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
4814 the current intensity setting, but will always convert the image to the
4815 appropriate sRGB or linear-RGB colorspace before appling the above
4818 <p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4820 <p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
4822 <pre class="highlight"><code>-adaptive-blur
4825 -clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4826 -colors for gray colorspace
4827 -compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4829 -distort {ErodeIntensity, DilateIntensity}
4839 <div style="margin: auto;">
4840 <h3><a class="anchor" id="intent"></a>-intent <var>type</var></h3>
4843 <p class="magick-description">use this type of rendering intent when managing the image color.</p>
4845 <p>Use this option to affect the color management operation of an image (see
4846 <a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4847 Perceptual, Relative, Saturation</code>.</p>
4849 <p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4851 <p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4853 <div style="margin: auto;">
4854 <h3><a class="anchor" id="interlace"></a>-interlace <var>type</var></h3>
4857 <p class="magick-description">the type of interlacing scheme.</p>
4861 <pre class="highlight"><code>none
4870 <p>This option is used to specify the type of interlacing scheme for raw image
4871 formats such as <code>RGB</code> or <code>YUV</code>.</p>
4873 <p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4875 <p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4877 <p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4879 <p><code>Partition</code> is like plane except the different planes are saved to
4880 individual files (e.g. image.R, image.G, and image.B).</p>
4882 <p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4883 PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4885 <p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4888 <div style="margin: auto;">
4889 <h3><a class="anchor" id="interpolate"></a>-interpolate <var>type</var></h3>
4892 <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>
4894 <p>When looking up the color of a pixel using a non-integer floating point
4895 value, you typically fall in between the pixel colors defined by the source
4896 image. This setting determines how the color is determined from the colors of
4897 the pixels surrounding that point. That is how to determine the color of a
4898 point that falls between two, or even four different colored pixels. </p>
4901 <dt class="col-md-4">average</dt>
4902 <dd class="col-md-8">The average color of the surrounding four pixels</dd>
4903 <dt class="col-md-4">average4</dt>
4904 <dd class="col-md-8">The average color of the surrounding four pixels</dd>
4905 <dt class="col-md-4">average9</dt>
4906 <dd class="col-md-8">The average color of the surrounding nine pixels</dd>
4907 <dt class="col-md-4">average16</dt>
4908 <dd class="col-md-8">The average color of the surrounding sixteen pixels</dd>
4909 <dt class="col-md-4">background</dt>
4910 <dd class="col-md-8"> </dd>
4911 <dt class="col-md-4">bilinear</dt>
4912 <dd class="col-md-8">A double linear interpolation of pixels (the default)</dd>
4913 <dt class="col-md-4">blend</dt>
4914 <dd class="col-md-8"> </dd>
4915 <dt class="col-md-4">catrom</dt>
4916 <dd class="col-md-8">Fitted bicubic-spines of surrounding 16 pixels</dd>
4917 <dt class="col-md-4">integer</dt>
4918 <dd class="col-md-8">The color of the top-left pixel (floor function)</dd>
4919 <dt class="col-md-4">mesh</dt>
4920 <dd class="col-md-8">Divide area into two flat triangular interpolations</dd>
4921 <dt class="col-md-4">nearest-neighbor</dt>
4922 <dd class="col-md-8">The nearest pixel to the lookup point (rounded function)</dd>
4923 <dt class="col-md-4">spline</dt>
4924 <dd class="col-md-8">Direct spline curves (colors are blurred)</dd>
4927 <p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4928 >-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4929 >-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
4931 <p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4933 <p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
4934 lookup for positions outside the boundaries of the image. </p>
4937 <div style="margin: auto;">
4938 <h3><a class="anchor" id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4941 <p class="magick-description">the space between two text lines.</p>
4943 <div style="margin: auto;">
4944 <h3><a class="anchor" id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4947 <p class="magick-description">the space between two words.</p>
4949 <div style="margin: auto;">
4950 <h3><a class="anchor" id="kerning"></a>-kerning <var>value</var></h3>
4953 <p class="magick-description">the space between two letters.</p>
4955 <div style="margin: auto;">
4956 <h3><a class="anchor" id="kuwahara"></a>-kuwahara <var>radius</var><br />-kuwahara <var>radius</var>x<var>sigma</var></h3>
4959 <p class="magick-description">edge preserving noise reduction filter.</p>
4961 <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>
4964 <div style="margin: auto;">
4965 <h3><a class="anchor" id="label"></a>-label <var>name</var></h3>
4968 <p class="magick-description">assign a label to an image.</p>
4970 <p>Use this option to assign a specific label to the image, as it is read in
4971 or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
4972 a the labels of images already read in. Image formats such as TIFF, PNG,
4973 MIFF, supports saving the label information with the image.</p>
4975 <p>When saving an image to a <var>PostScript</var> file, any label
4976 assigned to an image is used as a header string to print above the postscript
4979 <p>You can include the image filename, type, width, height, or other image
4980 attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4981 Properties</a> for details of the percent escape codes.</p>
4985 <pre class="highlight"><code>-label "%m:%f %wx%h" bird.miff
4988 <p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4989 "<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4990 is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4991 existing label present in the image would be used. You can remove all labels
4992 from an image by assigning the empty string. </p>
4994 <p>A label is not drawn on the image, but is embedded in the image datastream
4995 via <var>Label</var> tag or similar mechanism. If you want the label to be
4996 visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4997 during the final processing in the creation of an image montage.</p>
4999 <p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
5000 remaining characters in the string. Labels in a file are literal, no embedded
5001 formatting characters are recognized.</p>
5004 <div style="margin: auto;">
5005 <h3><a class="anchor" id="lat"></a>-lat <var>width</var><br />-lat <var>width</var>x<var>height</var>{<var>+-</var>}<var>offset</var>{<var>%</var>}</h3>
5008 <p class="magick-description">perform local adaptive threshold.</p>
5010 <p>Adaptively threshold each pixel based on the value of pixels in a
5011 surrounding window. If the current pixel is lighter than this average plus
5012 the optional <code>offset</code>, then it is made white, otherwise it is made
5013 black. Small variations in pixel values such as found in scanned documents
5014 can be ignored if offset is positive. A negative offset will make it more
5015 sensitive to those small variations. </p>
5017 <p>This is commonly used to threshold images with an uneven background. It is
5018 based on the assumption that average color of the small window is the
5019 the local background color, from which to separate the foreground color. </p>
5022 <div style="margin: auto;">
5023 <h3><a class="anchor" id="layers"></a>-layers <var>method</var></h3>
5026 <p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
5028 <p>Perform various image operation methods to a ordered sequence of images
5029 which may represent either a set of overlaid 'image layers', a GIF disposal
5030 animation, or a fully-'coalesced' animation sequence. </p>
5032 <table class="table table-sm table-striped">
5035 <th style="width: 8%">Method</th>
5036 <th>Description</th>
5040 <td>compare-any</td>
5041 <td>Crop the second and later frames to the smallest rectangle
5042 that contains all the differences between the two images. No GIF <a
5043 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
5046 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
5047 >-deconstruct</a> operator, and does not preserve animations normal
5048 working, especially when animation used layer disposal methods such as
5049 '<code>Previous</code>' or '<code>Background</code>'. </td>
5053 <td>compare-clear</td>
5054 <td>As '<code>compare-any</code>' but crop to the bounds of any
5055 opaque pixels which become transparent in the second frame. That is the
5056 smallest image needed to mask or erase pixels for the next frame. </td>
5060 <td>compare-overlay</td>
5061 <td>As '<code>compare-any</code>' but crop to pixels that add
5062 extra color to the next image, as a result of overlaying color pixels.
5063 That is the smallest single overlaid image to add or change colors. </td>
5066 <tr><td></td><td>This can be used with the <a href="command-line-options.html#compose" >-compose</a> alpha
5067 composition method '<code>change-mask</code>', to reduce the image to
5068 just the pixels that need to be overlaid. </td>
5073 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
5074 >-coalesce</a> operator. Apply the layer disposal methods set in the
5075 current image sequence to form a fully defined animation sequence, as
5076 it should be displayed. Effectively converting a GIF animation into a
5077 'film strip'-like animation. </td>
5082 <td>Alpha Composition of two image lists, separated by a
5083 "<code>null:</code>" image, with the destination image list first, and
5084 the source images last. An image from each list are composited
5085 together until one list is finished. The separator image and source
5086 image lists are removed. </td>
5091 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
5092 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
5093 canvas size of the first image in each list. Unlike a normal <a
5094 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
5095 added to the final composite positioning of each image. </td> </tr>
5098 <td>If one of the image lists only contains one image, that image is
5099 applied to all the images in the other image list, regardless of which
5100 list it is. In this case it is the image meta-data of the list which
5107 <td>This like '<code>coalesce</code>' but shows the look of
5108 the animation after the layer disposal method has been applied, before
5109 the next sub-frame image is overlaid. That is the 'dispose' image that
5110 results from the application of the GIF <a href="command-line-options.html#dispose"
5111 >-dispose</a> method. This allows you to check what
5112 is going wrong with a particular animation you may be developing.
5118 <td>Create a canvas the size of the first images virtual
5119 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5120 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
5121 canvas. Images falling outside that canvas is clipped. Final
5122 image will have a zero virtual canvas offset. </td>
5126 <td>This usually used as one of the final 'image layering' operations
5127 overlaying all the prepared image layers into a final image. </td>
5131 <td>For a single image this method can also be used to fillout a virtual
5132 canvas with real pixels, or to underlay an opaque color to remove
5133 transparency from an image.</td>
5139 <td>As 'flatten' method but merging all the given image
5140 layers to create a new layer image just large enough to hold all the
5141 image without clipping or extra space. The new images virtual offset
5142 will preserve the position of the new layer, even if this offset is
5143 negative. The virtual canvas size of the first image is preserved.
5147 <tr><td></td><td>Caution is advised when handling image layers with
5148 negative offsets as few image file formats handle them correctly.
5149 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
5150 will remove the layer offset, and create an image in which all the
5151 overlaid image positions relative to each other is preserved, though
5152 not necessarily exactly where you specified them.
5156 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5157 without doing the'flatten' to merge the images together. </td>
5162 <td>As 'flatten' method but expanding the initial canvas size
5163 of the first image in a positive direction only so as to hold all the
5164 image layers. However as a virtual canvas is 'locked' to the origin,
5165 by its own definition, image layers with a negative offsets will still
5166 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5167 if this could be a problem. </td>
5171 <tr><td></td><td>This method is commonly used to layout individual image
5172 using various offset but without knowing the final canvas size. The
5173 resulting image will, like 'flatten' not have any virtual offset, so
5174 can be saved to any image file format. </td>
5180 <td>Optimize a coalesced animation, into GIF animation using
5181 a number of general techniques. This currently a short cut to
5182 apply both the '<code>optimize-frame</code>', and
5183 '<code>optimize-transparency</code>' methods but may be expanded to
5184 include other optimization methods as they are developed. </td>
5188 <td>optimize-frame</td>
5189 <td>Optimize a coalesced animation, into GIF animation by
5190 reducing the number of pixels per frame as much as possible by
5191 attempting to pick the best layer disposal method to use, while ensuring
5192 the result will continue to animate properly. </td>
5195 <tr><td></td><td> There is no guarantee that the best optimization is found.
5196 But then no reasonably fast GIF optimization algorithm can do this.
5197 However this does seem to do better than most other GIF frame
5198 optimizers seen. </td>
5202 <td>optimize-plus</td>
5203 <td>As '<code>optimize-frame</code>' but attempt to improve the
5204 overall optimization by adding extra frames to the animation, without
5205 changing the final look or timing of the animation. The frames are
5206 added to attempt to separate the clearing of pixels from the
5207 overlaying of new additional pixels from one animation frame to the
5208 next. If this does not improve the optimization (for the next frame
5209 only), it will fall back to the results of the previous normal
5210 '<code>optimize-frame</code>' technique. </td>
5213 <tr><td></td><td>There is the possibility that the change in the disposal
5214 style will result in a worsening in the optimization of later frames,
5215 though this is unlikely. In other words there no guarantee that it is
5216 better than the normal '<code>optimize-frame</code>' technique. For some
5217 animations however you can get a vast improvement in the final
5218 animation size. </td>
5222 <td>optimize-transparency</td>
5223 <td>Given a GIF animation, replace any pixel in the sub-frame
5224 overlay images with transparency, if it does not change the resulting
5225 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
5229 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5230 to compress into a smaller file size due to larger areas of one
5231 (transparent) color rather than a pattern of multiple colors repeating
5232 the current disposed image of the last frame. </td>
5236 <td>remove-dups</td>
5237 <td>Remove (and merge time delays) of duplicate consecutive
5238 images, so as to simplify layer overlays of coalesced animations.
5242 <tr><td></td><td>Usually this a result of using a constant time delay
5243 across the whole animation, or after a larger animation was split into
5244 smaller sub-animations. The duplicate frames could also have been
5245 used as part of some frame optimization methods. </td>
5249 <td>remove-zero</td>
5250 <td>Remove any image with a zero time delay, unless ALL the
5251 images have a zero time delay (and is not a proper timed animation, a
5252 warning is then issued). </td>
5255 <tr><td></td><td>In a GIF animation, such images are usually frames which
5256 provide partial intermediary updates between the frames that are
5257 actually displayed to users. These frames are usually added for
5258 improved frame optimization in GIF animations. </td>
5262 <td>trim-bounds</td>
5263 <td>Find the bounds of all the images in the current
5264 image sequence, then adjust the offsets so all images are contained on
5265 a minimal positive canvas. None of the image data is modified or
5266 merged, only the individual image virtual canvas size and offset.
5267 All the images is given the same canvas size, and and will have
5268 a positive offset, but will remain in the same position relative to
5269 each other. As a result of the minimal canvas size at least one image
5270 will touch every edge of that canvas. The image data touching those
5271 edges however may be transparent. </td>
5274 <tr><td></td><td>The result is much like if you used 'merge' followed by a
5275 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
5276 have been kept separate. If 'flatten' is used after using
5277 'trim-bounds' you will get the same result. </td>
5283 <p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5285 <p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5286 >-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5287 >-mosaic</a> are only aliases for the above methods and may be depreciated in
5288 the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5289 >-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5290 GIF <a href="command-line-options.html#dispose" >-dispose</a> and <a href="command-line-options.html#delay" >-delay</a>
5294 <div style="margin: auto;">
5295 <h3><a class="anchor" id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5298 <p class="magick-description">adjust the level of image channels.</p>
5300 <p>Given one, two or three values delimited with commas: black-point,
5301 white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5302 white points range from 0 to <var>QuantumRange</var>, or from 0 to
5303 100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5304 If a <code>%</code> sign is present anywhere in the string, both black and white
5305 points are percentages of the full color range. Gamma will do a <a
5306 href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
5307 default of 1.0 (no gamma correction) is assumed.</p>
5309 <p>In normal usage (<code>-level</code>) the image values are stretched so that
5310 the given '<code>black_point</code>' value in the original image is set to zero
5311 (or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5312 contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5313 image will then be adjusted. </p>
5315 <p>From ImageMagick v6.4.1-9 using the plus form of the operator
5316 (<code>+level</code>) or adding the special '!' flag anywhere in the argument
5317 list, will cause the operator to do the reverse of the level adjustment. That
5318 is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5319 in the original image, is adjusted to the given level values, allowing you to
5320 de-contrast, or compress the channel values within the image. The
5321 '<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5324 <p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5325 setting are adjusted (defaults to RGB color channels only), allowing you to
5326 limit the effect of this operator. </p>
5328 <p>Please note that the transparency channel is treated as 'matte'
5329 values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5332 <div style="margin: auto;">
5333 <h3><a class="anchor" id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5336 <p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5338 <p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5339 value value for each color channel is determined by the
5340 '<code>black_color</code>' and '<code>white_color</code>' colors given (as
5341 described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5343 <p>This effectively means the colors provided to <code>-level-colors</code>
5344 is mapped to become 'black' and 'white' respectively, with all the other
5345 colors linearly adjusted (or clipped) to match that change. Each channel is
5346 adjusted separately using the channel values of the colors specified. </p>
5348 <p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5349 will map the image color 'black' and 'white' to the given colors
5350 respectively, resulting in a gradient (de-contrasting) tint of the image to
5351 those colors. This can also be used to convert a plain grayscale image into a
5352 one using the gradient of colors specified. </p>
5354 <p>By supplying a single color with a comma separator either before or after
5355 that color, will just replace the respective 'black' or 'white' point
5356 respectively. But if no comma separator is provided, the given color is
5357 used for both the black and white color points, making the operator either
5358 threshold the images around that color (- form) or set all colors to that
5359 color (+ form). </p>
5362 <div style="margin: auto;">
5363 <h3><a class="anchor" id="limit"></a>-limit <var>type value</var></h3>
5366 <p class="magick-description">Set the pixel cache resource limit.</p>
5368 <p>Choose from: <code>width</code>, <code>height</code>, <code>area</code>, <code>memory</code>, <code>map</code>, <code>disk</code>, <code>file</code>, <code>thread</code>, <code>throttle</code>, or <code>time</code>.</p>
5370 <p>The value for <code>file</code> is in number of files. The other limits are
5371 in bytes. Define arguments for the memory, map, area, and disk resource limits
5372 with SI prefixes (.e.g 100MB).</p>
5374 <p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5375 memory map, and 18.45EB of disk. These limits are adjusted relative to the
5376 available resources on your computer if this information is available. When
5377 any limit is reached, ImageMagick fails in some fashion but attempts to take
5378 compensating actions, if possible. For example, the following limits
5381 <pre class="highlight"><code>-limit memory 32MiB -limit map 64MiB
5384 <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>
5386 <pre class="highlight"><code>-> identify -list resource
5400 <p>Requests for pixel storage to keep intermediate images are satisfied by one
5401 of three resource categories: in-memory pool, memory-mapped files pool, and
5402 disk pool (in that order) depending on the <a href="command-line-options.html#limit">‑limit</a> settings
5403 and whether the system honors a resource request. If the total size of
5404 allocated pixel storage in the given pool reaches the corresponding limit, the
5405 request is passed to the next pool. Additionally, requests that exceed the
5406 <code>area</code> limit automagically are allocated on disk.</p>
5408 <p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5409 image resource request. First, ImageMagick tries to allocate the pixels in
5410 memory. The request might be denied if the resource request exceeds the
5411 <code>memory</code> limit or if the system does not honor the request. If
5412 a memory request is not honored, the pixels are allocated to disk and the file
5413 is memory-mapped. However, if the allocation request exceeds the
5414 <code>map</code> limit, the resource allocation goes to disk. In all cases, if
5415 the resource request exceeds the <code>area</code> limit, the pixels are
5416 automagically cached to disk. If the disk has a hard limit, the program
5419 <p>In most cases you simply do not need to concern yourself with resource
5420 limits. ImageMagick chooses reasonable defaults and most images do not tax
5421 your computer resources. Where limits do come in handy is when you process
5422 images that are large or on shared systems where ImageMagick can consume all
5423 or most of the available memory. In this case, the ImageMagick workflow slows
5424 other processes or, in extreme cases, brings the system to a halt. Under
5425 these circumstances, setting limits give some assurances that the ImageMagick
5426 workflow will not interfere with other concurrent uses of the computer. For
5427 example, assume you have a web interface that processes images uploaded from
5428 the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5429 simply set the area limit to 10MiB:</p>
5431 <pre class="highlight"><code>-limit area 10MB
5434 <p>Now whenever a large image is processed, the pixels are automagically
5435 cached to disk instead of memory. This of course implies that large images
5436 typically process very slowly, simply because pixel processing in memory can
5437 be an order of magnitude faster than on disk. Because your web site users
5438 might inadvertently upload a huge image to process, you should set a disk
5441 <pre class="highlight"><code>-limit area 10MB -limit disk 500MB
5444 <p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5446 <p>In addition to command-line resource limit option, resources can be set
5447 with <a href="resources.html#environment" >environment variables</a>. Set the
5448 environment variables <code>MAGICK_AREA_LIMIT</code>,
5449 <code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5450 <code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5451 <code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5452 image area, disk space, open files, heap memory, memory map, number of threads
5453 of execution, and maximum elapsed time in seconds respectively.</p>
5455 <p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5456 their commands and then scouring the generated output for references to the
5457 pixel cache, in order to determine how the pixel cache was allocated and how
5458 resources were consumed. Advanced Unix/Linux users can pipe that output
5459 through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5462 <p>For more about ImageMagick's use of resources, see the section <b>Cache
5463 Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5464 ">Architecture</a> page. </p>
5466 <div style="margin: auto;">
5467 <h3><a class="anchor" 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>
5470 <p class="magick-description">Linear with saturation stretch.</p>
5472 <p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
5473 and uses a 'histogram bin' to determine the range of color values that needs to
5474 be stretched. However it then stretches those colors using the <a
5475 href="command-line-options.html#level" >-level</a> operator.</p>
5477 <p>As such while the initial determination may have 'binning' round off
5478 effects, the image colors are stretched mathematically, rather than using the
5479 histogram bins. This makes the operator more accurate. </p>
5481 <p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
5482 '<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5483 perfect stretch of the color range. </p>
5485 <p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
5486 normalization of mathematical images. </p>
5488 <p>This operator is under review for re-development. </p>
5491 <div style="margin: auto;">
5492 <h3><a class="anchor" id="linewidth"></a>-linewidth</h3>
5495 <p class="magick-description">the line width for subsequent draw operations.</p>
5497 <div style="margin: auto;">
5498 <h3><a class="anchor" id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5501 <p class="magick-description">rescale image with seam-carving.</p>
5503 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5505 <div style="margin: auto;">
5506 <h3><a class="anchor" id="list"></a>-list <var>type</var></h3>
5509 <p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5511 <pre class="pre-scrollable"><code>
5584 <p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5585 list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5588 <pre class="highlight"><code>identify -list list
5591 <div style="margin: auto;">
5592 <h3><a class="anchor" id="log"></a>-log <var>string</var></h3>
5595 <p class="magick-description">Specify format for debug log.</p>
5597 <p>This option specifies the format for the log printed when the <a
5598 href="command-line-options.html#debug">-debug</a> option is active.</p>
5600 <p>You can display the following components by embedding special format
5604 <dt class="col-md-4">%d</dt><dd class="col-md-8">domain</dd>
5605 <dt class="col-md-4">%e</dt><dd class="col-md-8">event</dd>
5606 <dt class="col-md-4">%f</dt><dd class="col-md-8">function</dd>
5607 <dt class="col-md-4">%l</dt><dd class="col-md-8">line</dd>
5608 <dt class="col-md-4">%m</dt><dd class="col-md-8">module</dd>
5609 <dt class="col-md-4">%p</dt><dd class="col-md-8">process ID</dd>
5610 <dt class="col-md-4">%r</dt><dd class="col-md-8">real CPU time</dd>
5611 <dt class="col-md-4">%t</dt><dd class="col-md-8">wall clock time</dd>
5612 <dt class="col-md-4">%u</dt><dd class="col-md-8">user CPU time</dd>
5613 <dt class="col-md-4">%%</dt><dd class="col-md-8">percent sign</dd>
5614 <dt class="col-md-4">\n</dt><dd class="col-md-8">newline</dd>
5615 <dt class="col-md-4">\r</dt><dd class="col-md-8">carriage return</dd>
5620 <pre class="highlight"><code>convert -debug coders -log "%u %m:%l %e" in.gif out.png
5623 <p>The default behavior is to print all of the components.</p>
5625 <div style="margin: auto;">
5626 <h3><a class="anchor" id="loop"></a>-loop <var>iterations</var></h3>
5629 <p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5631 <p>Set iterations to zero to repeat the animation an infinite number of times,
5632 otherwise the animation repeats itself up to <var>iterations</var>
5635 <div style="margin: auto;">
5636 <h3><a class="anchor" id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5639 <p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5641 <div style="margin: auto;">
5642 <h3><a class="anchor" id="magnify"></a>-magnify</h3>
5645 <p class="magick-description">double the size of the image with pixel art scaling.</p>
5648 <div style="margin: auto;">
5649 <h3><a class="anchor" id="map"></a>-map <var>type</var></h3>
5652 <p class="magick-description">Display image using this <var>type</var>.</p>
5654 <p>Choose from these <var>Standard Colormap</var> types:</p>
5656 <pre class="highlight"><code>best
5664 <p>The <var>X server</var> must support the <var>Standard
5665 Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5666 the type and <code>display</code> searches the list of colormap types in
5667 <code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5670 <div style="margin: auto;">
5671 <h3><a class="anchor" id="map_stream_"></a>-map <var>components</var></h3>
5674 <p class="magick-description">pixel map.</p>
5676 <p>Here are the valid components of a map:</p>
5679 <dt class="col-md-4">r</dt><dd class="col-md-8"> red pixel component</dd>
5680 <dt class="col-md-4">g</dt><dd class="col-md-8"> green pixel component</dd>
5681 <dt class="col-md-4">b</dt><dd class="col-md-8"> blue pixel component</dd>
5682 <dt class="col-md-4">a</dt><dd class="col-md-8"> alpha pixel component (0 is transparent)</dd>
5683 <dt class="col-md-4">o</dt><dd class="col-md-8"> opacity pixel component (0 is opaque)</dd>
5684 <dt class="col-md-4">i</dt><dd class="col-md-8"> grayscale intensity pixel component</dd>
5685 <dt class="col-md-4">c</dt><dd class="col-md-8"> cyan pixel component</dd>
5686 <dt class="col-md-4">m</dt><dd class="col-md-8"> magenta pixel component</dd>
5687 <dt class="col-md-4">y</dt><dd class="col-md-8"> yellow pixel component</dd>
5688 <dt class="col-md-4">k</dt><dd class="col-md-8"> black pixel component</dd>
5689 <dt class="col-md-4">p</dt><dd class="col-md-8"> pad component (always 0)</dd>
5692 <p>You can specify as many of these components as needed in any order (e.g.
5693 bgr). The components can repeat as well (e.g. rgbr).</p>
5696 <div style="margin: auto;">
5697 <h3><a class="anchor" id="mattecolor"></a>-mattecolor <var>color</var></h3>
5700 <p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5702 <p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5704 <p>The default matte color is <code>#BDBDBD</code>, <span
5705 style="background-color: #bdbdbd;">this shade of gray</span>.</p>
5707 <div style="margin: auto;">
5708 <h3><a class="anchor" id="maximum"></a>-maximum</h3>
5711 <p class="magick-description">return the maximum intensity of an image sequence.</p>
5713 <p>Select the 'maximum' value from all the surrounding pixels. </p>
5715 <p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
5718 <div style="margin: auto;">
5719 <h3><a class="anchor" id="median"></a>-median <var>geometry</var></h3>
5722 <p class="magick-description">apply a median filter to the image.</p>
5724 <p>Select the 'middle' value from all the surrounding pixels. </p>
5726 <p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
5729 <div style="margin: auto;">
5730 <h3><a class="anchor" id="mean-shift"></a>-mean-shift <var>width</var>x<var>height</var>{<var>+distance</var>{%}</h3>
5733 <p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5735 <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>
5737 <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>
5739 <div style="margin: auto;">
5740 <h3><a class="anchor" id="metric"></a>-metric <var>type</var></h3>
5743 <p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5748 <dt class="col-md-4">AE</dt><dd class="col-md-8"> absolute error count, number of different pixels (-fuzz affected)</dd>
5749 <dt class="col-md-4">DSSIM</dt><dd class="col-md-8"> structural dissimilarity index</dd>
5750 <dt class="col-md-4">FUZZ</dt><dd class="col-md-8"> mean color distance</dd>
5751 <dt class="col-md-4">MAE</dt><dd class="col-md-8"> mean absolute error (normalized), average channel error distance</dd>
5752 <dt class="col-md-4">MEPP</dt><dd class="col-md-8"> mean error per pixel (normalized mean error, normalized peak error)</dd>
5753 <dt class="col-md-4">MSE</dt><dd class="col-md-8"> mean error squared, average of the channel error squared</dd>
5754 <dt class="col-md-4">NCC</dt><dd class="col-md-8"> normalized cross correlation</dd>
5755 <dt class="col-md-4">PAE</dt><dd class="col-md-8"> peak absolute (normalized peak absolute)</dd>
5756 <dt class="col-md-4">PHASH</dt><dd class="col-md-8"> perceptual hash for the sRGB and HCLp colorspaces. Specify an alternative colorspace with <code>-define phash:colorspaces=<var>colorspace,colorspace,...</var></code></dd>
5757 <dt class="col-md-4">PSNR</dt><dd class="col-md-8"> peak signal to noise ratio</dd>
5758 <dt class="col-md-4">RMSE</dt><dd class="col-md-8"> root mean squared (normalized root mean squared)</dd>
5759 <dt class="col-md-4">SSIM</dt><dd class="col-md-8"> structural similarity index</dd>
5762 <p>Control the '<code>AE</code>', or absolute count of pixels that are different,
5763 with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
5764 only changed by a small amount). Use '<code>PAE</code>' to find the
5765 size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
5766 'similar', while '<code>MAE</code>' determines the factor needed
5767 for about half the pixels to be similar. </p>
5769 <p>The <code>MEPP</code> metric returns three different metrics
5770 ('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5771 normalized) from a single comparison run. </p>
5773 <p>The <code>SSIM</code> and <code>DSSIM</code> metrics respect these defines:
5774 <code>-define compare:ssim-radius</code>, <code>-define compare:ssim-sigma</code>,
5775 <code>-define compare:ssim-k1</code>, and <code>-define compare:ssim-k2</code>.</p>
5777 <p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5778 metric</a> option.</p>
5781 <div style="margin: auto;">
5782 <h3><a class="anchor" id="minimum"></a>-minimum</h3>
5785 <p class="magick-description">return the minimum intensity of an image sequence.</p>
5787 <p>Select the 'minimal' value from all the surrounding pixels. </p>
5789 <p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
5794 <div style="margin: auto;">
5795 <h3><a class="anchor" id="mode"></a>-mode <var>geometry</var></h3>
5798 <p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5800 <div style="margin: auto;">
5801 <h3>-mode <var>value</var></h3>
5804 <p class="magick-description">Mode of operation.</p>
5806 <p>Choose the <var>value</var> from these styles: <code>Frame,
5807 Unframe, or Concatenate</code></p>
5809 <p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5810 for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
5811 ImageMagick installation.</p>
5814 <div style="margin: auto;">
5815 <h3><a class="anchor" id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5818 <p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5820 <p>The arguments are given as a percentages of variation. A value of 100 means
5821 no change, and any missing values are taken to mean 100.</p>
5823 <p>The <var>brightness</var> is a multiplier of the overall
5824 brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5825 twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5826 before and after. </p>
5828 <p>The <var>saturation</var> controls the amount of color in an
5829 image. For example, 0 produce a grayscale image, while a large value such as
5830 200 produce a very colorful, 'cartoonish' color.</p>
5832 <p>The <var>hue</var> argument causes a "rotation" of the colors
5833 within the image by the amount specified. For example, 50 results in
5834 a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5835 A value of either 0 or 200 results in a complete 180 degree rotation of the
5836 image. Using a value of 300 is a 360 degree rotation resulting in no change to
5837 the original image. </p>
5839 <p>For example, to increase the color brightness by 20% and decrease the color
5840 saturation by 10% and leave the hue unchanged, use <a
5841 href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
5843 <p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5844 >option:modulate:colorspace</code>' to specify which colorspace to
5845 modulate. 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>
5847 <pre class="highlight"><code>convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5850 <div style="margin: auto;">
5851 <h3><a class="anchor" id="moments"></a>-moments</h3>
5854 <p class="magick-description">report image moments and perceptual hash.</p>
5857 <div style="margin: auto;">
5858 <h3><a class="anchor" id="monitor"></a>-monitor</h3>
5861 <p class="magick-description">monitor progress.</p>
5864 <div style="margin: auto;">
5865 <h3><a class="anchor" id="monochrome"></a>-monochrome</h3>
5868 <p class="magick-description">transform the image to black and white.</p>
5870 <div style="margin: auto;">
5871 <h3><a class="anchor" id="morph"></a>-morph <var>frames</var></h3>
5874 <p class="magick-description">morphs an image sequence.</p>
5876 <p>Both the image pixels and size are linearly interpolated to give the
5877 appearance of a metamorphosis from one image to the next, over all the images
5878 in the current image list. The added images are the equivalent of a <a
5879 href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
5880 argument determine how many images to interpolate between each image. </p>
5883 <div style="margin: auto;">
5884 <h3><a class="anchor" id="morphology"></a>-morphology</h3>
5885 <h3>-morphology <var>method</var> <var>kernel</var></h3>
5888 <p class="magick-description">apply a morphology method to the image.</p>
5890 <p>Until I get around to writing an option summary for this, see <a
5891 href="../Usage/morphology/" >IM Usage Examples,
5892 Morphology</a>. </p>
5895 <div style="margin: auto;">
5896 <h3><a class="anchor" id="mosaic"></a>-mosaic</h3>
5899 <p class="magick-description">an simple alias for the <a href="command-line-options.html#layers" >-layers</a> method "mosaic"</p>
5902 <div style="margin: auto;">
5903 <h3><a class="anchor" id="motion-blur"></a>-motion-blur <var>radius</var><br />-motion-blur <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
5906 <p class="magick-description">simulate motion blur.</p>
5908 <p>Blur with the given radius, standard deviation (sigma), and angle. The
5909 angle given is the angle toward which the image is blurred. That is the
5910 direction people would consider the object is coming from. </p>
5912 <p>Note that the blur is not uniform distribution, giving the motion a
5913 definite sense of direction of movement. </p>
5915 <p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5916 pixels which are outside the image proper are blurred into the final result.
5919 <div style="margin: auto;">
5920 <h3><a class="anchor" id="name"></a>-name</h3>
5923 <p class="magick-description">name an image.</p>
5924 <div style="margin: auto;">
5925 <h3><a class="anchor" id="negate"></a>-negate</h3>
5928 <p class="magick-description">replace each pixel with its complementary color.</p>
5930 <p>The red, green, and blue intensities of an image are negated. White becomes
5931 black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5932 negate the grayscale pixels of the image.</p>
5934 <div style="margin: auto;">
5935 <h3><a class="anchor" id="noise"></a>-noise <var>geometry</var><br/>
5936 +noise <var>type</var></h3>
5939 <p class="magick-description">Add or reduce noise in an image.</p>
5941 <p>The principal function of noise peak elimination filter is to smooth the
5942 objects within an image without losing edge information and without creating
5943 undesired structures. The central idea of the algorithm is to replace a pixel
5944 with its next neighbor in value within a pixel window, if this pixel has been
5945 found to be noise. A pixel is defined as noise if and only if this pixel is
5946 a maximum or minimum within the pixel window.</p>
5948 <p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5949 specify the width of the neighborhood when reducing noise. This is equivalent
5950 to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
5951 which should be used in preference.</p>
5953 <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
5956 <pre class="highlight"><code>Gaussian
5965 <p>The amount of noise added can be controlled by the <code><a
5966 href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
5967 equivalent to 1.0, or a maximum noise addition.</p>
5969 <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>
5971 <p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5973 <p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5974 the use of a controlling value to specify the amount of noise that should be
5975 added to an image. </p>
5978 <div style="margin: auto;">
5979 <h3><a class="anchor" id="normalize"></a>-normalize</h3>
5982 <p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5984 <p>The intensity values are stretched to cover the entire range of possible
5985 values. While doing so, black-out at most <var>2%</var> of the pixels and
5986 white-out at most <var>1%</var> of the pixels.</p>
5988 <p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5989 is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5990 (Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5991 >-contrast-stretch 2%x99%</a>).</p>
5993 <p>All the channels are normalized in concert by the same amount so as to
5994 preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5995 setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
5996 setting will normalize the RGB channels independently.</p>
5998 <p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5999 Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
6000 that is better suited to mathematically generated images. </p>
6002 <p>This operator is under review for re-development. </p>
6005 <div style="margin: auto;">
6006 <h3><a class="anchor" id="opaque"></a>-opaque <var>color</var></h3>
6009 <p class="magick-description">change this color to the fill color within the image.</p>
6011 <p>The <var>color</var> argument is defined using the format
6012 described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
6013 >-fuzz</a> setting can be used to match and replace colors similar to the one
6016 <p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
6017 the target color. </p>
6019 <p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
6020 as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
6021 transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
6022 To ensure that it can do this it also ensures that the image has an alpha
6023 channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
6024 the new transparent colors, and does not require you to modify the <a
6025 href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
6028 <div style="margin: auto;">
6029 <h3><a class="anchor" id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
6032 <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
6033 given number of <var>levels</var> per color channel.</p>
6035 <p>You can choose from these standard threshold maps:</p>
6037 <pre class="pre-scrollable"><code>
6038 threshold 1x1 Threshold 1x1 (non-dither)
6039 checks 2x1 Checkerboard 2x1 (dither)
6040 o2x2 2x2 Ordered 2x2 (dispersed)
6041 o3x3 3x3 Ordered 3x3 (dispersed)
6042 o4x4 4x4 Ordered 4x4 (dispersed)
6043 o8x8 8x8 Ordered 8x8 (dispersed)
6044 h3x4a 4x1 Halftone 4x4 (angled)
6045 h6x6a 6x1 Halftone 6x6 (angled)
6046 h8x8a 8x1 Halftone 8x8 (angled)
6047 h3x4o Halftone 4x4 (orthogonal)
6048 h6x6o Halftone 6x6 (orthogonal)
6049 h8x8o Halftone 8x8 (orthogonal)
6050 h36x16o Halftone 16x16 (orthogonal)
6051 c5x5b c5x5 Circles 5x5 (black)
6052 c5x5w Circles 5x5 (white)
6053 c6x6b c6x6 Circles 6x6 (black)
6054 c6x6w Circles 6x6 (white)
6055 c7x7b c7x7 Circles 7x7 (black)
6056 c7x7w Circles 7x7 (white)
6059 <p> The <code>threshold</code> generated a simple 50% threshold of the image.
6060 This could be used with <var >level</var> to do the equivalent of <a
6061 href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
6064 <p>The <code>checks</code> pattern produces a 3 level checkerboard dither
6065 pattern. That is a grayscale will become a pattern of solid black, solid
6066 white, and mid-tone colors into a checkerboard pattern of black and white.
6069 <p>You can define your own <var >threshold map</var> for ordered
6070 dithering and halftoning your images, in either personal or system
6071 <code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
6072 for more details of configuration files. </p>
6074 <p>To print a complete list of the thresholds that have been defined, use the
6075 <a href="command-line-options.html#list" >-list threshold</a> option.</p>
6077 <p>Note that at this time the same threshold dithering map is used for all
6078 color channels, no attempt is made to offset or rotate the map for different
6079 channels is made, to create an offset printing effect. Also as the maps are
6080 simple threshold levels, the halftone and circle maps will create incomplete
6081 circles along the edges of a colored area. Also all the effects are purely
6082 on/off boolean effects, without anti-aliasing to make the circles smooth
6083 looking. Large dots can be made to look better with a small amount of blurring
6084 after being created. </p>
6087 <div style="margin: auto;">
6088 <h3><a class="anchor" id="orient"></a>-orient <var>image orientation</var></h3>
6091 <p class="magick-description">specify orientation of a digital camera image.</p>
6093 <p>Choose from these orientations:</p>
6095 <pre class="highlight"><code>bottom-left right-top
6096 bottom-right top-left
6097 left-bottom top-right
6102 <p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
6103 orientation</a> option.</p>
6106 <div style="margin: auto;">
6107 <h3><a class="anchor" id="page"></a>-page <var>geometry</var><br/>
6108 -page <var>media</var>[<var>offset</var>][{<var>^!<></var>}]<br/>
6113 <p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6115 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6117 <p>For convenience you can specify the page size using <var>media</var> (see below). Offsets can then be added as with other
6118 <var>geometry</var> arguments (e.g. <a
6119 href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
6121 <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.
6122 The choices for a PostScript page are:</p>
6125 <dt class="col-md-4"> 11x17 </dt> <dd class="col-md-8"> 792 x 1224</dd>
6126 <dt class="col-md-4"> Ledger </dt> <dd class="col-md-8"> 1224 x 792</dd>
6127 <dt class="col-md-4"> Legal </dt> <dd class="col-md-8"> 612 x 1008</dd>
6128 <dt class="col-md-4"> Letter </dt> <dd class="col-md-8"> 612 x 792</dd>
6129 <dt class="col-md-4"> LetterSmall</dt> <dd class="col-md-8"> 612 x 792</dd>
6130 <dt class="col-md-4"> ArchE </dt> <dd class="col-md-8"> 2592 x 3456</dd>
6131 <dt class="col-md-4"> ArchD </dt> <dd class="col-md-8"> 1728 x 2592</dd>
6132 <dt class="col-md-4"> ArchC </dt> <dd class="col-md-8"> 1296 x 1728</dd>
6133 <dt class="col-md-4"> ArchB </dt> <dd class="col-md-8"> 864 x 1296</dd>
6134 <dt class="col-md-4"> ArchA </dt> <dd class="col-md-8"> 648 x 864</dd>
6135 <dt class="col-md-4"> A0 </dt> <dd class="col-md-8"> 2380 x 3368</dd>
6136 <dt class="col-md-4"> A1 </dt> <dd class="col-md-8"> 1684 x 2380</dd>
6137 <dt class="col-md-4"> A2 </dt> <dd class="col-md-8"> 1190 x 1684</dd>
6138 <dt class="col-md-4"> A3 </dt> <dd class="col-md-8"> 842 x 1190</dd>
6139 <dt class="col-md-4"> A4 </dt> <dd class="col-md-8"> 595 x 842</dd>
6140 <dt class="col-md-4"> A4Small </dt> <dd class="col-md-8"> 595 x 842</dd>
6141 <dt class="col-md-4"> A5 </dt> <dd class="col-md-8"> 421 x 595</dd>
6142 <dt class="col-md-4"> A6 </dt> <dd class="col-md-8"> 297 x 421</dd>
6143 <dt class="col-md-4"> A7 </dt> <dd class="col-md-8"> 210 x 297</dd>
6144 <dt class="col-md-4"> A8 </dt> <dd class="col-md-8"> 148 x 210</dd>
6145 <dt class="col-md-4"> A9 </dt> <dd class="col-md-8"> 105 x 148</dd>
6146 <dt class="col-md-4"> A10 </dt> <dd class="col-md-8"> 74 x 105</dd>
6147 <dt class="col-md-4"> B0 </dt> <dd class="col-md-8"> 2836 x 4008</dd>
6148 <dt class="col-md-4"> B1 </dt> <dd class="col-md-8"> 2004 x 2836</dd>
6149 <dt class="col-md-4"> B2 </dt> <dd class="col-md-8"> 1418 x 2004</dd>
6150 <dt class="col-md-4"> B3 </dt> <dd class="col-md-8"> 1002 x 1418</dd>
6151 <dt class="col-md-4"> B4 </dt> <dd class="col-md-8"> 709 x 1002</dd>
6152 <dt class="col-md-4"> B5 </dt> <dd class="col-md-8"> 501 x 709</dd>
6153 <dt class="col-md-4"> C0 </dt> <dd class="col-md-8"> 2600 x 3677</dd>
6154 <dt class="col-md-4"> C1 </dt> <dd class="col-md-8"> 1837 x 2600</dd>
6155 <dt class="col-md-4"> C2 </dt> <dd class="col-md-8"> 1298 x 1837</dd>
6156 <dt class="col-md-4"> C3 </dt> <dd class="col-md-8"> 918 x 1298</dd>
6157 <dt class="col-md-4"> C4 </dt> <dd class="col-md-8"> 649 x 918</dd>
6158 <dt class="col-md-4"> C5 </dt> <dd class="col-md-8"> 459 x 649</dd>
6159 <dt class="col-md-4"> C6 </dt> <dd class="col-md-8"> 323 x 459</dd>
6160 <dt class="col-md-4"> Flsa </dt> <dd class="col-md-8"> 612 x 936</dd>
6161 <dt class="col-md-4"> Flse </dt> <dd class="col-md-8"> 612 x 936</dd>
6162 <dt class="col-md-4"> HalfLetter </dt> <dd class="col-md-8"> 396 x 612</dd>
6165 <p>This option is also used to place subimages when writing to a multi-image
6166 format that supports offsets, such as GIF89 and MNG. When used for this
6167 purpose the offsets are always measured from the top left corner of the canvas
6168 and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6169 position 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
6170 file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6171 the sequence with nonzero width and height defines the width and height values
6172 that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6173 height are computed from the bounding box that contains all images in the
6174 sequence. When writing a GIF89 file, only the bounding box method is used to
6175 determine its dimensions.</p>
6177 <p>For a PostScript page, the image is sized as in <a
6178 href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6179 left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6180 href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
6181 page. If the image size exceeds the PostScript page, it is reduced to fit the
6182 page. 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
6183 corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6184 present with a value other than <var>NorthWest</var>.</p>
6186 <p>The default page dimensions for a TEXT image is 612x792.</p>
6188 <p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6190 <p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6192 <div style="margin: auto;">
6193 <h3><a class="anchor" id="paint"></a>-paint <var>radius</var></h3>
6196 <p class="magick-description">simulate an oil painting.</p>
6198 <p>Each pixel is replaced by the most frequent color in a circular
6199 neighborhood whose width is specified with <var>radius</var>.</p>
6201 <div style="margin: auto;">
6202 <h3><a class="anchor" id="path"></a>-path <var>path</var></h3></div>
6204 <p class="magick-description">write images to this path on disk.</p>
6206 <div style="margin: auto;">
6207 <h3><a class="anchor" id="pause_animate_"></a>-pause <var>seconds</var></h3>
6210 <p class="magick-description">Pause between animation loops</p>
6212 <p>Pause for the specified number of seconds before repeating the animation.</p>
6214 <div style="margin: auto;">
6215 <h3><a class="anchor" id="pause_import_"></a>-pause <var>seconds</var></h3>
6218 <p class="magick-description">Pause between snapshots.</p>
6220 <p>Pause for the specified number of seconds before taking the next snapshot.</p>
6222 <div style="margin: auto;">
6223 <h3><a class="anchor" id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6226 <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>
6228 <div style="margin: auto;">
6229 <h3><a class="anchor" id="ping"></a>-ping</h3>
6232 <p class="magick-description">efficiently determine image characteristics.</p>
6234 <div style="margin: auto;">
6235 <h3><a class="anchor" id="pointsize"></a>-pointsize <var>value</var></h3>
6238 <p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6240 <div style="margin: auto;">
6241 <h3><a class="anchor" id="polaroid"></a>-polaroid <var>angle</var></h3>
6244 <p class="magick-description">simulate a Polaroid picture.</p>
6246 <p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6248 <div style="margin: auto;">
6249 <h3><a class="anchor" id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6252 <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>
6254 <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>
6256 <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>
6258 <p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6260 <p>Some simple uses are:</p>
6262 <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>
6263 <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>
6266 <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>
6268 <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>
6271 <div style="margin: auto;">
6272 <h3><a class="anchor" id="posterize"></a>-posterize <var>levels</var></h3>
6275 <p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6277 <p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6280 <div style="margin: auto;">
6281 <h3><a class="anchor" id="precision"></a>-precision <var>value</var></h3>
6284 <p class="magick-description">set the maximum number of significant digits to be printed.</p>
6286 <div style="margin: auto;">
6287 <h3><a class="anchor" id="preview"></a>-preview <var>type</var></h3>
6290 <p class="magick-description">image preview type.</p>
6292 <p>Use this option to affect the preview operation of an image (e.g.
6293 <code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6296 <pre class="pre-scrollable"><code>
6328 <p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6330 <p>The default preview is <code>JPEG</code>.</p>
6332 <div style="margin: auto;">
6333 <h3><a class="anchor" id="print"></a>-print <var>string</var></h3>
6336 <p class="magick-description">interpret string and print to console.</p>
6338 <div style="margin: auto;">
6339 <h3><a class="anchor" id="process"></a>-process <var>command</var></h3>
6342 <p class="magick-description">process the image with a custom image filter.</p>
6344 <p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6345 argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6346 "Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6347 pass to the process module.</p>
6349 <div style="margin: auto;">
6350 <h3><a class="anchor" id="profile"></a>-profile <var>filename</var><br/>
6351 +profile <var>profile_name</var></h3>
6354 <p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6356 <p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6357 ICM (ICC color management), IPTC (newswire information), or a generic profile
6360 <p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6361 remove the indicated profile. ImageMagick uses standard filename globbing, so
6362 wildcard expressions may be used to remove more than one profile. Here we
6363 remove all profiles from the image except for the XMP profile: <code>+profile
6364 "!xmp,*"</code>. </p>
6366 <p>Use <code>identify -verbose</code> to find out which profiles are in the
6367 image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6370 <p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6371 used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6373 <p>For example, to extract the Exif data (which is stored in JPEG files in the
6374 <var>APP1</var> profile), use.</p>
6376 <pre class="highlight"><code>convert cockatoo.jpg profile.exif
6379 <p>It is important to note that results may depend on whether or not the
6380 original image already has an included profile. Also, keep in mind that <a
6381 href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
6382 therefore a conversion is made each time it is encountered, in order, in the
6383 command-line. For instance, in the following example, if the original image is
6384 CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6386 <pre class="highlight"><code>convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6389 <p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6390 conversion steps can yield unwanted results. CMYK profiles are often very
6391 asymmetric since they involve 3−>4 and 4−>3 channel mapping.
6394 <div style="margin: auto;">
6395 <h3><a class="anchor" id="quality"></a>-quality <var>value</var></h3>
6398 <p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6400 <p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6401 highest compression) to 100 (best quality but least effective compression).
6402 The default is to use the estimated quality of your input image if it can
6403 be determined, otherwise 92. When the quality is greater than 90, then the
6404 chroma channels are not downsampled.
6405 Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6406 factors for chroma downsampling.</p>
6408 <p>For the JPEG-2000 image format, quality is mapped using a non-linear
6409 equation to the compression ratio required by the Jasper library. This
6410 non-linear equation is intended to loosely approximate the quality provided by
6411 the JPEG v1 format. The default quality value 100, a request for non-lossy
6412 compression. A quality of 75 results in a request for 16:1 compression.</p>
6414 <p>For the MNG and PNG image formats, the quality value sets the zlib
6415 compression level (quality / 10) and filter-type (quality % 10). The default
6416 PNG "quality" is 75, which means compression level 7 with adaptive PNG
6417 filtering, unless the image has a color map, in which case it means
6418 compression level 7 with no PNG filtering.</p>
6420 <p>For compression level 0 (quality value less than 10), the Huffman-only
6421 strategy is used, which is fastest but not necessarily the worst
6424 <p>If filter-type is 4 or less, the specified PNG filter-type is used for
6428 <dt class="col-md-4">0</dt><dd class="col-md-8">none</dd>
6429 <dt class="col-md-4">1</dt><dd class="col-md-8">sub</dd>
6430 <dt class="col-md-4">2</dt><dd class="col-md-8">up</dd>
6431 <dt class="col-md-4">3</dt><dd class="col-md-8">average</dd>
6432 <dt class="col-md-4">4</dt><dd class="col-md-8">Paeth</dd>
6435 <p>If filter-type is 5, adaptive filtering is used when quality is greater
6436 than 50 and the image does not have a color map, otherwise no filtering is
6439 <p>If filter-type is 6, adaptive filtering
6440 with <var>minimum-sum-of-absolute-values</var> is used.</p>
6442 <p>Only if the output is MNG, if filter-type is 7, the LOCO color
6443 transformation (intrapixel differencing) and adaptive filtering
6444 with <var>minimum-sum-of-absolute-values</var> are used.</p>
6446 <p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6447 Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6448 adaptive PNG filtering.</p>
6450 <p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6451 Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6452 no PNG filtering.</p>
6454 <p>The quality setting has no effect on the appearance or signature of PNG
6455 and MNG images, since the compression is always lossless.</p>
6457 <p>Not all combinations of compression level, strategy, and PNG filter type
6458 can be obtained using the -quality option. For more precise control,
6459 you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6460 PNG:compression-filter=N defines, respectively, instead.
6461 See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6462 over values from the -quality option.</p>
6464 <p>For further information, see
6465 the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6467 <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>
6469 <p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6471 <div style="margin: auto;">
6472 <h3><a class="anchor" id="quantize"></a>-quantize <var>colorspace</var></h3>
6475 <p class="magick-description">reduce colors using this colorspace.</p>
6477 <p>This setting defines the colorspace used to sort out and reduce the number
6478 of colors needed by an image (for later dithering) by operators such as <a
6479 href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
6480 automatically when saving images to color-limited image file formats, such as
6484 <div style="margin: auto;">
6485 <h3><a class="anchor" id="quiet"></a>-quiet</h3>
6488 <p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6490 <div style="margin: auto;">
6491 <h3><a class="anchor" id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6494 <p class="magick-description">Blur around the center of the image.</p>
6496 <p>Note that this is actually a rotational blur rather than a radial and as
6497 such actually mis-named. </p>
6499 <p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6500 pixels which are outside the image proper are blurred into the final result.
6504 <div style="margin: auto;">
6505 <h3><a class="anchor" id="raise"></a>-raise <var>thickness</var></h3>
6508 <p class="magick-description">Lighten or darken image edges.</p>
6510 <p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6511 a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6513 <p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6514 href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
6516 <div style="margin: auto;">
6517 <h3><a class="anchor" id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6520 <p class="magick-description">Apply a random threshold to the image.</p>
6522 <div style="margin: auto;">
6523 <h3><a class="anchor" id="read-mask"></a>-read-mask
6524 <var>filename</var></h3>
6527 <p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6529 <p>This the same as using a mask used for composite masking operations, with
6530 grayscale values causing blended updates of the image the mask is attached to.
6533 <p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6535 <p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6536 but with strict boolean masking. </p>
6538 <div style="margin: auto;">
6539 <h3><a class="anchor" id="red-primary"></a>-red-primary <var>x,y</var></h3>
6542 <p class="magick-description">Set the red chromaticity primary point.</p>
6544 <div style="margin: auto;">
6545 <h3><a class="anchor" id="regard-warnings"></a>-regard-warnings</h3>
6548 <p class="magick-description">Pay attention to warning messages.</p>
6550 <p>This option causes some warnings in some image formats to be treated
6553 <div style="margin: auto;">
6554 <h3><a class="anchor" id="remap"></a>-remap <var>filename</var></h3>
6557 <p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6559 <p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6560 the given colors are dithered over the image as necessary, otherwise the closest
6561 color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6563 <p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6564 images in the current image sequence, all the images will have the same color
6565 table. That means that when saved to a file format such as GIF, it will use
6566 that color table as a single common or global color table, for all the images,
6567 without requiring extra local color tables. </p>
6569 <p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6570 sequence to use a common color map over all the images. This equivalent to
6571 appending all the images together (without extra background colors) and color
6572 reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6573 limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6574 images. This ensures all the images follow a single color map. </p>
6576 <p>If the number of colors over all the images is less than 256, then <a
6577 href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
6578 no color changes are needed. In that case, its only effect is to force the use
6579 of a global color table. This recommended after using either <a
6580 href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#ordered-dither">-ordered-dither</a> to
6581 reduce the number of colors in an animated image sequence. </p>
6583 <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>
6585 <div style="margin: auto;">
6586 <h3><a class="anchor" id="region"></a>-region <var>geometry</var></h3>
6589 <p class="magick-description">Set a region in which subsequent operations apply.</p>
6591 <p>The <var>x</var> and <var>y</var> offsets are treated
6592 in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6594 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6596 <p>Use <code>+region</code> to remove any previously set regions.</p>
6598 <div style="margin: auto;">
6599 <h3><a class="anchor" id="remote"></a>-remote</h3>
6602 <p class="magick-description">perform a remote operation.</p>
6604 <p>The only command recognized is the name of an image file to load.</p>
6606 <p>If you have more than one <a href="display.html">display</a> application
6607 running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6608 specify which application to control.</p>
6610 <div style="margin: auto;">
6611 <h3><a class="anchor" id="render"></a>-render</h3>
6614 <p class="magick-description">render vector operations.</p>
6616 <p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6617 This useful when saving the result to vector formats such as MVG or SVG.</p>
6619 <div style="margin: auto;">
6620 <h3><a class="anchor" id="repage"></a>-repage <var>geometry</var></h3>
6623 <p class="magick-description">Adjust the canvas and offset information of the image.</p>
6625 <p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6626 rather than a setting. You can separately set the canvas size or the offset
6627 of the image on that canvas by only providing those components. </p>
6629 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6631 <p>If a <code>!</code> flag is given the offset given is added to the existing
6632 offset to move the image relative to its previous position. This useful for
6633 animation sequences. </p>
6635 <p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6636 recalculate the canvas size so the image (at its current offset) will appear
6637 completely on that canvas (unless it has a negative offset).</p>
6639 <p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6640 canvas meta-data from the images. </p>
6642 <p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6643 directly assign virtual canvas meta-data. </p>
6646 <div style="margin: auto;">
6647 <h3><a class="anchor" id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6650 <p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6652 <p>Resize the image so that its rendered size remains the same as the original
6653 at the specified target resolution. For example, if a 300 DPI image renders at
6654 3 inches by 2 inches on a 300 DPI device, when the image has been resampled to
6655 72 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6656 only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6657 storing the image resolution. For formats which do not support an image
6658 resolution, the original resolution of the image must be specified via <a
6659 href="command-line-options.html#density">-density</a> on the command line prior to specifying the
6660 resample resolution.</p>
6662 <p>Note that Photoshop stores and obtains image resolution from a proprietary
6663 embedded profile. If this profile exists in the image, then Photoshop will
6664 continue to treat the image using its former resolution, ignoring the image
6665 resolution specified in the standard file header.</p>
6667 <div style="margin: auto;">
6668 <h3><a class="anchor" id="resize"></a>-resize <var>geometry</var></h3>
6671 <p class="magick-description">Resize an image.</p>
6673 <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
6674 ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6676 <p>If the <a href="command-line-options.html#filter">-filter</a> option
6677 or <code>-define filter:option=value</code> precedes the <a
6678 href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
6681 <p>Many image processing algorithms assume your image is in a linear-light
6682 coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6683 correction, apply the transform, then restore it like this:</p>
6685 <pre class="highlight"><code>convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6686 -quality 92 passport.jpg
6689 <div style="margin: auto;">
6690 <h3><a class="anchor" id="respect-parentheses"></a>-respect-parentheses</h3>
6693 <p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6695 <div style="margin: auto;">
6696 <h3><a class="anchor" id="reverse"></a>-reverse</h3>
6699 <p class="magick-description">Reverse the order of images in the current image list.</p>
6702 <div style="margin: auto;">
6703 <h3><a class="anchor" id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6706 <p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6708 <p>A negative <var>x</var> offset rolls the image right-to-left.
6709 A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6712 <div style="margin: auto;">
6713 <h3><a class="anchor" id="rotate"></a>-rotate <var>degrees</var>{<var><</var>}{<var>></var>}</h3>
6716 <p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6718 <p>Use <code>></code> to rotate the image only if its width exceeds the
6719 height. <code><</code> rotates the image <var>only</var> if its width is less
6720 than the height. For example, if you specify <code>-rotate "-90>"</code> and
6721 the image size is 480x640, the image is not rotated. However, if the image is
6722 640x480, it is rotated by -90 degrees. If you use <code>></code> or
6723 <code><</code>, enclose it in quotation marks to prevent it from being
6724 misinterpreted as a file redirection.</p>
6726 <p>Empty triangles in the corners, left over from rotating the image, are
6727 filled with the <code>background</code> color. </p>
6729 <p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6730 '<code>ScaleRotateTranslate</code>' distort method. </p>
6733 <div style="margin: auto;">
6734 <h3><a class="anchor" id="sample"></a>-sample <var>geometry</var></h3>
6737 <p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6739 <p>Change the image size simply by directly sampling the pixels original
6740 from the image. When magnifying, pixels are replicated in blocks. When
6741 minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6744 <p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6745 a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6746 neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6747 avoids all the filter processing of the image. As such it completely ignores
6748 the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6750 <p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6751 will be added to the resulting image, though some colors may disappear. </p>
6753 <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
6754 ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6757 <p>The actual sampling point is the middle of the sub-region being sampled.
6758 As such a single pixel sampling of an image will take the middle pixel, (or
6759 top-left-middle if image has even dimensions). However the <a
6760 href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
6761 this position some other location within each sub-region being sampled, as
6762 a percentage offset.</p>
6764 <p>By default this value is '<code>50</code>' for the midpoint, but could be set
6765 to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6766 separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6767 sampling sub-region.</p>
6770 <div style="margin: auto;">
6771 <h3><a class="anchor" id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6774 <p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6776 <p>This option specifies the sampling factors to be used by the JPEG encoder
6777 for chroma downsampling. If this option is omitted, the JPEG library will use
6778 its own default values. When reading or writing the YUV format and when
6779 writing the M2V (MPEG-2) format, use <a
6780 href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6781 href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
6782 downsampling method.</p>
6784 <div style="margin: auto;">
6785 <h3><a class="anchor" id="scale"></a>-scale <var>geometry</var></h3>
6788 <p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6790 <p>Change the image size simply by replacing pixels by averaging pixels
6791 together when minifying, or replacing pixels when magnifying. </p>
6793 <p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6794 a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6795 faster, as it avoids all the filter processing of the image. As such it
6796 completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6798 <p>If when shrinking (minifying) images the original image is some integer
6799 multiple of the new image size, the number of pixels averaged together to
6800 produce the new pixel color is the same across the whole image. This is
6801 a special case known as 'binning' and is often used as a method of reducing
6802 noise in image such as those generated by digital cameras, especially in low
6803 light conditions. </p>
6806 <div style="margin: auto;">
6807 <h3><a class="anchor" id="scene"></a>-scene <var>value</var></h3>
6810 <p class="magick-description">set scene number.</p>
6812 <p>This option sets the scene number of an image or the first image in an image sequence.</p>
6814 <div style="margin: auto;">
6815 <h3><a class="anchor" id="screen"></a>-screen</h3>
6818 <p class="magick-description">specify the screen to capture.</p>
6820 <p>This option indicates that the GetImage request used to obtain the image
6821 should be done on the root window, rather than directly on the specified
6822 window. In this way, you can obtain pieces of other windows that overlap the
6823 specified window, and more importantly, you can capture menus or other popups
6824 that are independent windows but appear over the specified window.</p>
6826 <div style="margin: auto;">
6827 <h3><a class="anchor" id="seed"></a>-seed</h3>
6830 <p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6832 <div style="margin: auto;">
6833 <h3><a class="anchor" id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6836 <p class="magick-description">segment the colors of an image.</p>
6838 <p>Segment an image by analyzing the histograms of the color components and
6839 identifying units that are homogeneous with the fuzzy c-means technique. This
6840 is part of the ImageMagick color quantization routines. </p>
6842 <p>Specify <var>cluster threshold</var> as the number of pixels in
6843 each cluster that must exceed the cluster threshold to be considered valid.
6844 <var>Smoothing threshold</var> eliminates noise in the second
6845 derivative of the histogram. As the value is increased, you can expect
6846 a smoother second derivative. The default is 1.5.</p>
6848 <p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6849 of the color clusters is returned.</p>
6852 <div style="margin: auto;">
6853 <h3><a class="anchor" id="selective-blur"></a>-selective-blur <var>radius</var><br />-selective-blur <var>radius</var>x<var>sigma</var>{<var>+threshold</var>}</h3>
6856 <p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6858 <p>Blurs those pixels that are less than or equal to the threshold in
6859 contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6861 <div style="margin: auto;">
6862 <h3><a class="anchor" id="separate"></a>-separate</h3>
6865 <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>
6867 <div style="margin: auto;">
6868 <h3><a class="anchor" id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
6871 <p class="magick-description">simulate a sepia-toned photo.</p>
6873 <p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6875 <p>This option applies a special effect to the image, similar to the effect
6876 achieved 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
6877 toning. A threshold of 80% is a good starting point for a reasonable
6882 <div style="margin: auto;">
6883 <h3><a class="anchor" id="set"></a>-set <var>key value</var></h3>
6884 <h3>+set <var>key</var></h3>
6887 <p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6889 <p>This will assign (or modify) specific settings attached to all the images
6890 in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6891 option will either remove, or reset that setting to a default state, as
6894 <p>For example, it will modify specific well known image meta-data
6895 'attributes' such as those normally overridden by: the options <a
6896 href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6897 href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
6898 assigned before the image is read in, by using a <var>key</var> of
6901 <p>If the given <var>key</var> does not match a specific known
6902 'attribute ', such as shown above, the setting is stored as a a free form
6903 'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6904 >-verbose</a> information ("<code>info:</code>" output format) as "Properties".
6907 <p>This includes string 'properties' that are set by and assigned to images
6908 using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6909 >-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6910 a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
6911 Escapes</a> expanded) to images as they are read in. For example:</p>
6913 <pre class="highlight"><code>-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
6914 identify -format %c rose.png
6915 Rose is a rose is a rose is a rose
6918 <p>The set value can also make use of <a href="escape.html" >Format and Print Image
6919 Properties</a> in the defined value. For example:</p>
6921 <pre class="highlight"><code>-> convert rose: -set origsize '%wx%h' -resize 50% \
6922 -format 'Old size = %[origsize] New size = %wx%h' info:
6923 Old size = 70x46 New size = 35x23
6926 <p>Other well known 'properties' that are available include:
6927 '<code>date:create</code>' and '<code>date:modify</code>' and
6928 '<code>signature</code>'. </p>
6930 <p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6931 the '<code>page</code>' attribute of an image for images already in memory (also
6932 see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6933 control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6934 option will only provide a direct, unmodified assignment of '<code>page</code>'
6937 <p>This option can also associate a colorspace or profile with your image.
6940 <pre class="highlight"><code>convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6943 <p>Some 'properties' must be defined in a specific way to be used. For
6944 example only 'properties' prefixed with "<code>filename:</code>" can be used to
6945 modify the output filename of an image. For example</p>
6947 <pre class="highlight"><code>convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6950 <p>If the setting value is prefixed with "<code>option:</code>" the setting will
6951 be saved as a global "Artifact" exactly as if it was set using the <a
6952 href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
6953 can be used to pass 'attributes' and 'properties' of one specific image,
6954 in a way that allows you to use them in a completely different image, even if
6955 the original image has long since been modified or destroyed. For example: </p>
6957 <pre class="highlight"><code>convert rose: -set option:rosesize '%wx%h' -delete 0 \
6958 label:'%[rosesize]' label_size_of_rose.gif"
6961 <p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
6962 a 'artifact' if the given <var>key</var> does not match an existing
6963 'attribute' or 'property'. </p>
6965 <p>You can set the attributes of the image registry by prefixing the value
6966 with <code>registry:</code>.</p>
6968 <p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6969 previously-formatted ancillary chunks into the output PNG file, using
6970 the commandline option as shown below or by setting the profile via a
6971 programming interface:</p>
6973 <pre class="highlight"><code>convert in.png -set profile PNG-chunk-x:<filename> out.png
6976 <p>where <var>x</var> is a location flag and
6977 <var>filename</var> is a file containing the chunk
6978 name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6979 This encoder will compute the chunk length and CRC, so those must not
6980 be included in the file.</p>
6982 <p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6983 or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6984 of the same type, then add a short unique string after the "x" to prevent
6985 subsequent profiles from overwriting the preceding ones, e.g.,</p>
6988 <pre class="highlight"><code>convert in.png -set profile PNG-chunk-b01:file01 \
6989 -profile PNG-chunk-b02:file02 out.png
6992 <div style="margin: auto;">
6993 <h3><a class="anchor" id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6996 <p class="magick-description">shade the image using a distant light source.</p>
6998 <p>Specify <var>azimuth</var> and <var>elevation</var> as
6999 the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
7000 the shading results as a grayscale image.</p>
7002 <div style="margin: auto;">
7003 <h3><a class="anchor" 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>
7006 <p class="magick-description">simulate an image shadow.</p>
7008 <div style="margin: auto;">
7010 id="shared-memory"></a>-shared-memory</h3>
7013 <p class="magick-description">use shared memory.</p>
7015 <p>This option specifies whether the utility should attempt to use shared
7016 memory for pixmaps. ImageMagick must be compiled with shared memory support,
7017 and the display must support the <var>MIT-SHM</var> extension.
7018 Otherwise, this option is ignored. The default is <code>True</code>.</p>
7020 <div style="margin: auto;">
7021 <h3><a class="anchor" id="sharpen"></a>-sharpen <var>radius</var><br />-sharpen <var>radius</var>x<var>sigma</var></h3>
7024 <p class="magick-description">sharpen the image.</p>
7026 <p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
7028 <div style="margin: auto;">
7029 <h3><a class="anchor" id="shave"></a>-shave <var>geometry</var></h3>
7032 <p class="magick-description">Shave pixels from the image edges.</p>
7034 <p>The <var>size</var> portion of the <var>geometry</var>
7035 argument specifies the width of the region to be removed from both sides of
7036 the image and the height of the regions to be removed from top and bottom.
7037 Offsets are ignored.</p>
7039 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7041 <div style="margin: auto;">
7042 <h3><a class="anchor" id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
7045 <p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
7047 <p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
7048 given, the horizontal component of the shear is performed before the vertical
7051 <p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
7052 horizontally or vertically, respectively),creating a parallelogram. The amount
7053 of each is controlled by the respective shear angle. For horizontal shears,
7054 <var>Xdegrees</var> is measured clockwise relative to "up" (the
7055 negative y-axis), sliding the top edge to the right when 0°<<var>Xdegrees</var><90° and to the left when 90°<<var>Xdegrees</var><180°. For vertical shears <var>Ydegrees</var> is measured clockwise relative to "right" (the
7056 positive x-axis), sliding the right edge down when 0°<<var>Ydegrees</var><90° and up when 90°<<var>Ydegrees</var><180°.</p>
7058 <p>Empty triangles left over from shearing the image are filled with the color
7059 defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
7060 using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7062 <p>The horizontal shear is performed before the vertical part. This is
7063 important to note, since horizontal and vertical shears do not
7064 <var>commute</var>, i.e., the order matters in a sequence of shears. For
7065 example, the following two commands are not equivalent.</p>
7067 <pre class="highlight"><code>convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
7068 convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
7071 <p>The first of the two commands above is equivalent to the following, except
7072 for the amount of empty space created; the command that follows generates
7073 a smaller image, and so is a better choice in terms of time and space.</p>
7075 <pre class="highlight"><code>convert logo: -shear 20x60 logo-sheared.png
7078 <div style="margin: auto;">
7079 <h3><a class="anchor" id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7082 <p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7084 <p>Increase the contrast of the image using a sigmoidal transfer function
7085 without saturating highlights or shadows. <var>Contrast</var>
7086 indicates how much to increase the contrast. For example, 0 is none, 3 is
7087 typical and 20 is a lot.
7090 <p>The <var>mid-point</var> indicates where the maximum change
7091 'slope' in contrast should fall in the resultant image (0 is white; 50% is
7092 middle-gray; 100% is black). </p>
7094 <p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7096 <p>To achieve the equivalent of a sigmoidal brightness change (similar to
7097 a gamma adjustment), you would use <var>-sigmoidal-contrast
7098 {brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7099 Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7101 <p>Using a very high <var>contrast</var> will produce a sort of
7102 'smoothed thresholding' of the image. Not as sharp (with high aliasing
7103 effects) of a true threshold, but with tapered gray-levels around the threshold
7104 <var>mid-point</var>. </p>
7106 <div style="margin: auto;">
7107 <h3><a class="anchor" id="silent"></a>-silent</h3>
7112 <p class="magick-description">operate silently. This option is only used
7113 by the <a href="import.html">import</a> tool.</p>
7115 <div style="margin: auto;">
7116 <h3><a class="anchor" id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7119 <p class="magick-description">minimum RMSE for subimage match.</p>
7121 <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>
7123 <div style="margin: auto;">
7124 <h3><a class="anchor" id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7127 <p class="magick-description">set the width and height of the image.</p>
7129 <p>Use this option to specify the width and height of raw images whose
7130 dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
7131 <code>CMYK</code>. In addition to width and height, use <a
7132 href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
7133 image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7136 <p>For Photo CD images, choose from these sizes:</p>
7138 <pre class="highlight"><code>192x128
7145 <div style="margin: auto;">
7146 <h3><a class="anchor" id="sketch"></a>-sketch <var>radius</var><br />-sketch <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
7149 <p class="magick-description">simulate a pencil sketch.</p>
7151 <p>Sketch with the given radius, standard deviation (sigma), and angle. The
7152 angle given is the angle toward which the image is sketched. That is the
7153 direction people would consider the object is coming from. </p>
7155 <div style="margin: auto;">
7156 <h3><a class="anchor" id="smush"></a>-smush <var>offset</var></h3>
7159 <p class="magick-description">appends an image sequence together ignoring transparency.</p>
7161 <p>Smush is a more flexible version of <a href="command-line-options.html#append">-append</a>, joining the images in the sequence top-to-bottom (<a href="command-line-options.html#smush">-smush</a>) or left-to-right (<a href="command-line-options.html#smush">+smush</a>), with a gap between images according to the specified offset.</p>
7163 <p>If the offset is negative, images will overlap by that amount.</p>
7165 <p><a href="command-line-options.html#smush">-smush</a> respects <a href="command-line-options.html#gravity">-gravity</a>. Any empty space will be filled with the <a href="command-line-options.html#background">-background</a> color.</p>
7167 <p>For zero offset and transparent images, the non-transparent parts of the two images will be aligned as close as possible without overlapping.</p>
7169 <div style="margin: auto;">
7170 <h3><a class="anchor" id="snaps"></a>-snaps <var>value</var></h3>
7173 <p class="magick-description">Set the number of screen snapshots.</p>
7175 <p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7177 <div style="margin: auto;">
7178 <h3><a class="anchor" id="solarize"></a>-solarize <var>percent-threshold</var></h3>
7181 <p class="magick-description">negate all pixels above the threshold level.</p>
7183 <p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7185 <p>This option produces a <var>solarization</var> effect seen when
7186 exposing a photographic film to light during the development process.</p>
7188 <div style="margin: auto;">
7189 <h3><a class="anchor" id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7192 <p class="magick-description"> color the given image using the specified points of color, and filling the other intervening colors using the given methods. </p>
7196 <dt class="col-md-4">barycentric</dt>
7197 <dd class="col-md-8">three point triangle of color given 3 points.
7198 Giving only 2 points will form a linear gradient between those points.
7199 The gradient generated extends beyond the triangle created by those
7201 <dt class="col-md-4">bilinear</dt>
7202 <dd class="col-md-8">Like barycentric but for 4 points. Less than 4 points
7203 fall back to barycentric. </dd>
7204 <dt class="col-md-4">voronoi</dt>
7205 <dd class="col-md-8">Simply map each pixel to the to nearest color point
7206 given. The result are polygonal 'cells' of solid color. </dd>
7207 <dt class="col-md-4">manhattan</dt>
7208 <dd class="col-md-8">Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7209 <dt class="col-md-4">shepards</dt>
7210 <dd class="col-md-8">Colors points biased on the ratio of inverse distance
7211 squared. Generating spots of color in a sea of the average of
7213 <dt class="col-md-4">inverse</dt>
7214 <dd class="col-md-8">Colors points biased on the ratio of inverse distance.
7215 This generates sharper points of color rather than rounded spots of
7216 '<code>shepards</code>' Generating spots of color in a sea of the
7217 average of colors. </dd>
7220 <p>The points are placed according to the images location on the virtual
7221 canvas (<a href="command-line-options.html#page" >-page</a> or <a href="command-line-options.html#repage" >-repage</a>
7222 offset), and do not actually have to exist on the given image, but may be
7223 some point beyond the edge of the image. All points are floating point values.
7226 <p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
7227 modified, which means that by default matte/alpha transparency channel is not
7228 affected. Typically transparency channel is turned off either before or after
7231 <p>Of course if some color points are transparent to generate a transparent
7232 gradient, then the image also requires transparency enabled to store the
7235 <p>All the above methods when given a single point of color will replace all
7236 the colors in the image with the color given, regardless of the point. This is
7237 logical, and provides an alternative technique to recolor an image to some
7241 <div style="margin: auto;">
7242 <h3><a class="anchor" id="splice"></a>-splice <var>geometry</var></h3>
7245 <p class="magick-description">Splice the current background color into the image.</p>
7247 <p>This will add rows and columns of the current <a
7248 href="command-line-options.html#background">-background</a> color into the given image according to the
7249 given <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
7250 image into four quadrants, separating them by the inserted rows and columns.
7253 <p>If a dimension of geometry is zero no rows or columns will be added for that
7254 dimension. Similarly using a zero offset with the appropriate <a
7255 href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7256 the image, padding the image only along that one edge. Edge padding is what <a
7257 href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
7259 <p>If the exact same <var>geometry</var> and <a
7260 href="command-line-options.html#gravity">-gravity</a> is later used with <a href="command-line-options.html#chop">-chop</a> the
7261 added added all splices removed. </p>
7263 <div style="margin: auto;">
7264 <h3><a class="anchor" id="spread"></a>-spread <var>amount</var></h3>
7267 <p class="magick-description">displace image pixels by a random amount.</p>
7269 <p>The argument <var>amount</var> defines the size of the
7270 neighborhood around each pixel from which to choose a candidate pixel to
7273 <p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7275 <div style="margin: auto;">
7276 <h3><a class="anchor" id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7279 <p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7281 <p>Choose from these statistic types:</p>
7283 <dt class="col-md-4">Gradient</dt><dd class="col-md-8">maximum difference (max - min) value in neighborhood</dd>
7284 <dt class="col-md-4">Maximum</dt><dd class="col-md-8">maximum value per channel in neighborhood</dd>
7285 <dt class="col-md-4">Minimum</dt><dd class="col-md-8">minimum value per channel in neighborhood</dd>
7286 <dt class="col-md-4">Mean</dt><dd class="col-md-8">average value per channel in neighborhood</dd>
7287 <dt class="col-md-4">Median</dt><dd class="col-md-8">median value per channel in neighborhood</dd>
7288 <dt class="col-md-4">Mode</dt><dd class="col-md-8">mode (most frequent) value per channel in neighborhood</dd>
7289 <dt class="col-md-4">Nonpeak</dt><dd class="col-md-8">value just before or after the median value per channel in neighborhood</dd>
7290 <dt class="col-md-4">RMS</dt><dd class="col-md-8">root mean square value per channel in neighborhood</dd>
7291 <dt class="col-md-4">StandardDeviation</dt><dd class="col-md-8"> standard deviation value per channel in neighborhood</dd>
7294 <div style="margin: auto;">
7295 <h3><a class="anchor" id="stegano"></a>-stegano <var>offset</var></h3>
7298 <p class="magick-description">hide watermark within an image.</p>
7300 <p>Use an offset to start the image hiding some number of pixels from the
7301 beginning of the image. Note this offset and the image size. You will need
7302 this information to recover the steganographic image (e.g. display -size
7303 320x256+35 stegano:image.png).</p>
7305 <div style="margin: auto;">
7306 <h3><a class="anchor" id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7309 <p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7311 <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>
7313 <div style="margin: auto;">
7314 <h3><a class="anchor" id="storage-type"></a>-storage-type <var>type</var></h3>
7317 <p class="magick-description">pixel storage type. Here are the valid types:</p>
7320 <dt class="col-md-4">char</dt><dd class="col-md-8">unsigned characters</dd>
7321 <dt class="col-md-4">double</dt><dd class="col-md-8">doubles</dd>
7322 <dt class="col-md-4">float</dt><dd class="col-md-8">floats</dd>
7323 <dt class="col-md-4">integer</dt><dd class="col-md-8">integers</dd>
7324 <dt class="col-md-4">long</dt><dd class="col-md-8">longs</dd>
7325 <dt class="col-md-4">quantum</dt><dd class="col-md-8">pixels in the native depth of your ImageMagick distribution</dd>
7326 <dt class="col-md-4">short</dt><dd class="col-md-8">unsigned shorts</dd>
7329 <p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7330 values range from 0 to the maximum value the storage type can support.</p>
7332 <div style="margin: auto;">
7333 <h3><a class="anchor" id="stretch"></a>-stretch <var>fontStretch</var></h3>
7336 <p class="magick-description">Set a type of stretch style for fonts.</p>
7338 <p>This setting suggests a type of stretch that ImageMagick should try to
7339 apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7341 <pre class="highlight"><code>Any
7353 <p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7356 <p>For other settings that affect fonts, see the options <a
7357 href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7358 href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
7360 <div style="margin: auto;">
7361 <h3><a class="anchor" id="strip"></a>-strip</h3>
7364 <p class="magick-description">strip the image of any profiles, comments or these PNG chunks: bKGD,cHRM,EXIF,gAMA,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date.</p>
7366 <div style="margin: auto;">
7367 <h3><a class="anchor" id="stroke"></a>-stroke <var>color</var></h3>
7370 <p class="magick-description">color to use when stroking a graphic primitive.</p>
7372 <p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7374 <p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7376 <div style="margin: auto;">
7377 <h3><a class="anchor" id="strokewidth"></a>-strokewidth <var>value</var></h3>
7380 <p class="magick-description">set the stroke width.</p>
7382 <p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7384 <div style="margin: auto;">
7385 <h3><a class="anchor" id="style"></a>-style <var>fontStyle</var></h3>
7388 <p class="magick-description">Set a font style for text.</p>
7390 <p>This setting suggests a font style that ImageMagick should try to apply to
7391 the currently selected font family. Select <var>fontStyle</var> from
7394 <pre class="highlight"><code>Any
7400 <p>For other settings that affect fonts, see the options <a
7401 href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7402 href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
7404 <div style="margin: auto;">
7405 <h3><a class="anchor" id="subimage-search"></a>-subimage-search</h3>
7408 <p class="magick-description">search for subimage.</p>
7410 <p>This option is required to have compare search for the best match location
7411 of a small image within a larger image. This search will produce two images
7412 (or two frames). The first is the "difference" image and the second will
7413 be the "match score" image.</p>
7415 <p>The "match-score" image is smaller containing a pixel for ever possible
7416 position of the top-left corner of the given sub-image. that is its size will
7417 be the size of the larger_image - sub_image + 1. The brightest location in
7418 this image is the location s the locate on the best match that is also
7419 reported. Note that this may or may not be a perfect match, and the actual
7420 brightness will reflect this. Other bright 'peaks' can be used to locate other
7421 possible matching locations. </p>
7423 <p>Note that the search will try to compare the sub-image at every possible
7424 location in the larger image, as such it can be very slow. The smaller the
7425 sub-image the faster this search is. </p>
7428 <div style="margin: auto;">
7429 <h3><a class="anchor" id="swap"></a>-swap <var>index,index</var></h3>
7432 <p class="magick-description">Swap the positions of two images in the image sequence.</p>
7434 <p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7435 images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7436 the last two images in the sequence.</p>
7438 <div style="margin: auto;">
7439 <h3><a class="anchor" id="swirl"></a>-swirl <var>degrees</var></h3>
7442 <p class="magick-description">swirl image pixels about the center.</p>
7444 <p><var>Degrees</var> defines the tightness of the swirl.</p>
7446 <div style="margin: auto;">
7447 <h3><a class="anchor" id="synchronize"></a>-synchronize</h3>
7450 <p class="magick-description">synchronize image to storage device.</p>
7452 <p>Set to "true" to ensure all image data is fully flushed and synchronized
7453 to disk. There is a performance penalty, but the benefits include ensuring a
7454 valid image file in the event of a system crash and early reporting if there
7455 is not enough disk space for the image pixel cache.</p>
7457 <div style="margin: auto;">
7458 <h3><a class="anchor" id="taint"></a>-taint</h3>
7461 <p class="magick-description">Mark the image as modified.</p>
7463 <div style="margin: auto;">
7464 <h3><a class="anchor" id="text-font"></a>-text-font <var>name</var></h3>
7467 <p class="magick-description">font for writing fixed-width text.</p>
7469 <p>Specifies the name of the preferred font to use in fixed (typewriter style)
7470 formatted text. The default is 14 point <var>Courier</var>.</p>
7472 <p>You can tag a font to specify whether it is a PostScript, TrueType, or
7473 OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7474 <code>x:fixed</code> is OPTION1.</p>
7476 <div style="margin: auto;">
7477 <h3><a class="anchor" id="texture"></a>-texture <var>filename</var></h3>
7480 <p class="magick-description">name of texture to tile onto the image background.</p>
7482 <div style="margin: auto;">
7483 <h3><a class="anchor" id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7486 <!-- {<var>green,blue,opacity</var>}
7487 <p>If the green or blue value is omitted, these channels use the same value as
7488 the first one provided. If all three color values are the same, the result is
7489 a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7490 and any partially transparent pixel becomes fully transparent.</p>
7493 <p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7495 <p>Any pixel values (more specifically, those channels set using <a href="command-line-options.html#channel">‑channel</a>) that exceed the specified threshold are reassigned the
7496 maximum channel value, while all other values are assigned the minimum.</p>
7498 <p> The threshold value can be given as a percentage or as an absolute integer
7499 value corresponding to the desired channel value. When given as an integer,
7500 the minimum attainable value is 0 (corresponding to black when all channels
7501 are affected), but the maximum value (corresponding to white) is that of the
7502 <code>quantum depth</code> of the particular build of ImageMagick, and is
7503 therefore dependent on the installation. For that reason, a reasonable
7504 recommendation for most applications is to specify the threshold values as
7507 <p> The following would force pixels with red values above 50% to have 100%
7508 red values, while those at or below 50% red would be set to 0 in the red
7509 channel. The green, blue, and alpha channels (if present) would be unchanged.
7512 <pre class="highlight"><code>convert in.png -channel red -threshold 50% out.png
7515 <p>As (possibly) impractical but instructive examples, the following would
7516 generate an all-black and an all-white image with the same dimensions as the
7520 <pre class="highlight"><code>convert in.png -threshold 100% black.png
7521 convert in.png -threshold -1 white.png
7524 <p>Note that the values of the transparency channel is treated as 'matte'
7525 values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7527 <p> See also <a href="command-line-options.html#black-threshold">‑black‑threshold</a> and <a href="command-line-options.html#white-threshold">‑white‑threshold</a>.
7530 <div style="margin: auto;">
7531 <h3><a class="anchor" id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7534 <p class="magick-description">Create a thumbnail of the image.</p>
7536 <p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7537 for speed and any image profile, other than a color profile, is removed to
7538 reduce the thumbnail size. To strip the color profiles as well, add <a
7539 href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
7541 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7543 <div style="margin: auto;">
7544 <h3><a class="anchor" id="tile"></a>-tile <var>filename</var></h3>
7547 <p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7549 <div style="margin: auto;">
7550 <h3>-tile <var>geometry</var></h3>
7553 <p class="magick-description">Specify the layout of images.</p>
7555 <p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7557 <div style="margin: auto;">
7561 <p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7563 <div style="margin: auto;">
7564 <h3><a class="anchor" id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7567 <p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7569 <p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7570 >-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
7571 creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7574 <p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
7575 by the arguments given when the tile image is set. </p>
7577 <div style="margin: auto;">
7578 <h3><a class="anchor" id="tint"></a>-tint <var>value</var></h3>
7581 <p class="magick-description">Tint the image with the fill color.</p>
7583 <p>Tint the image with the fill color.</p>
7585 <p>Specify the amount of tinting as a percentage. Pure colors like black,
7586 white red, yellow, will not be affected by -tint. Only mid-range colors such
7587 as the various shades of grey.</p>
7589 <div style="margin: auto;">
7590 <h3><a class="anchor" id="title"></a>-title <var>string</var></h3>
7593 <p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7595 <p>Use this option to assign a specific title to the image. This assigned to
7596 the image window and is typically displayed in the window title bar.
7597 Optionally you can include the image filename, type, width, height, Exif data,
7598 or other image attribute by embedding special format characters described
7599 under the <a href="command-line-options.html#format">-format</a> option.</p>
7603 <pre class="highlight"><code>-title "%m:%f %wx%h"
7606 <p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7607 titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7610 <div style="margin: auto;">
7611 <h3><a class="anchor" id="transform"></a>-transform</h3>
7614 <p class="magick-description">transform the image.</p>
7616 <p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7618 <pre class="highlight"><code>convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7622 <p>This operator has been now been superseded by the <a
7623 href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
7626 <div style="margin: auto;">
7627 <h3><a class="anchor" id="transparent"></a>-transparent <var>color</var></h3>
7630 <p class="magick-description">Make this color transparent within the image.</p>
7632 <p>The <var>color</var> argument is defined using the format
7633 described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7634 >-fuzz</a> setting can be used to match and replace colors similar to the one
7637 <p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
7638 that is make all non-matching colors transparent. </p>
7640 <p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7641 href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
7642 current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
7643 However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7644 that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7645 >-alpha</a> set</code>", and does not require you to modify the <a
7646 href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
7648 <p>Note that this does not define the color as being the 'transparency color'
7649 used for color-mapped image formats, such as GIF. For that use <a
7650 href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
7653 <div style="margin: auto;">
7654 <h3><a class="anchor" id="transparent-color"></a>-transparent-color <var>color</var></h3>
7657 <p class="magick-description">Set the transparent color.</p>
7659 <p>Sometimes this is used for saving to image formats such as
7660 GIF and PNG8 which uses this color to represent boolean transparency. This
7661 does not make a color transparent, it only defines what color the transparent
7662 color is in the color palette of the saved image. Use <a
7663 href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
7665 <p>This option allows you to have both an opaque visible color, as well as a
7666 transparent color of the same color value without conflict. That is, you can
7667 use the same color for both the transparent and opaque color areas within an
7668 image. This, in turn, frees to you to select a transparent color that is
7669 appropriate when an image is displayed by an application that does not handle a
7670 transparent color index, while allowing ImageMagick to correctly handle images of this
7673 <p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7675 <div style="margin: auto;">
7676 <h3><a class="anchor" id="transpose"></a>-transpose</h3>
7679 <p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7681 <p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7684 <div style="margin: auto;">
7685 <h3><a class="anchor" id="transverse"></a>-transverse</h3>
7688 <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>
7691 <div style="margin: auto;">
7692 <h3><a class="anchor" id="treedepth"></a>-treedepth <var>value</var></h3>
7695 <p class="magick-description">tree depth for the color reduction algorithm.</p>
7697 <p>Normally, this integer value is zero or one. A value of zero or one causes
7698 the use of an optimal tree depth for the color reduction algorithm.</p>
7700 <p>An optimal depth generally allows the best representation of the source
7701 image with the fastest computational speed and the least amount of memory.
7702 However, the default depth is inappropriate for some images. To assure the
7703 best representation, try values between 2 and 8 for this parameter. Refer to
7704 the <a href="../www/quantize.html"
7705 >color reduction algorithm</a> for more details.</p>
7707 <p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7708 option, or writing to an image format which requires color reduction, is
7709 required for this option to take effect.</p>
7711 <div style="margin: auto;">
7712 <h3><a class="anchor" id="trim"></a>-trim</h3>
7715 <p class="magick-description">trim an image.</p>
7717 <p>This option removes any edges that are exactly the same color as the corner
7718 pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7719 edges that are nearly the same color as the corner pixels.</p>
7721 <p>The page or virtual canvas information of the image is preserved allowing
7722 you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7723 image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7724 information if it is unwanted.</p>
7726 <p>If the trimmed image 'disappears' an warning is produced, and a special
7727 single pixel transparent 'missed' image is returned, in the same way as when a
7728 <a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7731 <div style="margin: auto;">
7732 <h3><a class="anchor" id="type"></a>-type <var>type</var></h3>
7735 <p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7736 <code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7737 <code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7738 <code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7740 <p>Normally, when a format supports different subformats such as grayscale and
7741 truecolor, the encoder will try to choose an efficient subformat. The <a
7742 href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
7743 example, to prevent a JPEG from being written in grayscale format even though
7744 only gray pixels are present, use.</p>
7746 <pre class="highlight"><code>convert bird.png -type TrueColor bird.jpg
7749 <p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7750 encoder to write an alpha channel even though the image is opaque, if the
7751 output format supports transparency.</p>
7753 <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>
7755 <div style="margin: auto;">
7756 <h3><a class="anchor" id="undercolor"></a>-undercolor <var>color</var></h3>
7759 <p class="magick-description">set the color of the annotation bounding box.</p>
7761 <p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7763 <p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7766 <div style="margin: auto;">
7767 <h3><a class="anchor" id="update"></a>-update <var>seconds</var></h3>
7770 <p class="magick-description">detect when image file is modified and redisplay.</p>
7772 <p>Suppose that while you are displaying an image the file that is currently
7773 displayed is over-written. <code>display</code> will automagically detect that
7774 the input file has been changed and update the displayed image
7778 <div style="margin: auto;">
7779 <h3><a class="anchor" id="unique-colors"></a>-unique-colors</h3>
7782 <p class="magick-description">discard all but one of any pixel color.</p>
7785 <div style="margin: auto;">
7786 <h3><a class="anchor" id="units"></a>-units <var>type</var></h3>
7789 <p class="magick-description">the units of image resolution.</p>
7791 <p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7792 <code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7793 with the <a href="command-line-options.html#density">-density</a> option.</p>
7796 <div style="margin: auto;">
7797 <h3><a class="anchor" id="unsharp"></a>-unsharp <var>radius</var><br />-unsharp <var>radius</var>x<var>sigma</var>{<var>+gain</var>}{<var>+threshold</var>}</h3>
7800 <p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7802 <p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7803 convolved with a Gaussian operator of the given radius and standard deviation
7804 (sigma). For reasonable results, radius should be larger than sigma. Use
7805 a radius of 0 to have the method select a suitable radius.</p>
7807 <p>The parameters are:</p>
7810 <dt class="col-md-4">radius</dt>
7811 <dd class="col-md-8">The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7812 <dt class="col-md-4">sigma</dt>
7813 <dd class="col-md-8">The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7814 <dt class="col-md-4">gain</dt>
7815 <dd class="col-md-8">The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7816 <dt class="col-md-4">threshold</dt>
7817 <dd class="col-md-8">The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7820 <div style="margin: auto;">
7821 <h3><a class="anchor" id="verbose"></a>-verbose</h3>
7824 <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>
7827 <div style="margin: auto;">
7828 <h3><a class="anchor" id="version"></a>-version</h3>
7831 <p class="magick-description">print ImageMagick version string and exit.</p>
7834 <div style="margin: auto;">
7835 <h3><a class="anchor" id="view"></a>-view <var>string</var></h3>
7838 <p class="magick-description">FlashPix viewing parameters.</p>
7841 <div style="margin: auto;">
7842 <h3><a class="anchor" id="vignette"></a>-vignette <var>radius</var>{x<var>sigma</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var>{<var>%</var>}</h3>
7845 <p class="magick-description">soften the edges of the image in vignette style.</p>
7847 <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>
7849 <div style="margin: auto;">
7850 <h3><a class="anchor" id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7853 <p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7855 <p>This option defines what color source should be used if and when a color
7856 lookup completely 'misses' the source image. The color(s) that appear to
7857 surround the source image. Generally this color is derived from the source
7858 image, but could also be set to a specify background color. </p>
7860 <p>Choose from these methods:</p>
7863 <dt class="col-md-4">background</dt><dd class="col-md-8">the area surrounding the image is the background color</dd>
7864 <dt class="col-md-4">black</dt><dd class="col-md-8">the area surrounding the image is black</dd>
7865 <dt class="col-md-4">checker-tile</dt><dd class="col-md-8">alternate squares with image and background color</dd>
7866 <dt class="col-md-4">dither</dt><dd class="col-md-8">non-random 32x32 dithered pattern</dd>
7867 <dt class="col-md-4">edge</dt><dd class="col-md-8">extend the edge pixel toward infinity</dd>
7868 <dt class="col-md-4">gray</dt><dd class="col-md-8">the area surrounding the image is gray</dd>
7869 <dt class="col-md-4">horizontal-tile</dt><dd class="col-md-8">horizontally tile the image, background color above/below</dd>
7870 <dt class="col-md-4">horizontal-tile-edge</dt><dd class="col-md-8">horizontally tile the image and replicate the side edge pixels</dd>
7871 <dt class="col-md-4">mirror</dt><dd class="col-md-8">mirror tile the image</dd>
7872 <dt class="col-md-4">random</dt><dd class="col-md-8">choose a random pixel from the image</dd>
7873 <dt class="col-md-4">tile</dt><dd class="col-md-8">tile the image (default)</dd>
7874 <dt class="col-md-4">transparent</dt><dd class="col-md-8">the area surrounding the image is transparent blackness</dd>
7875 <dt class="col-md-4">vertical-tile</dt><dd class="col-md-8">vertically tile the image, sides are background color</dd>
7876 <dt class="col-md-4">vertical-tile-edge</dt><dd class="col-md-8">vertically tile the image and replicate the side edge pixels</dd>
7877 <dt class="col-md-4">white</dt><dd class="col-md-8">the area surrounding the image is white</dd>
7880 <p>The default value is "edge".</p>
7882 <p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7883 >-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, and <a href="command-line-options.html#fx" >-fx</a>.
7884 However it also affects operations that may access pixels just outside the
7885 image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7886 href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
7888 <p>To print a complete list of virtual pixel types, use the <a
7889 href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
7892 <div style="margin: auto;">
7893 <h3><a class="anchor" id="visual"></a>-visual <var>type</var></h3>
7896 <p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7898 <p>Choose from these visual classes:</p>
7900 <pre class="highlight"><code>StaticGray TrueColor
7901 GrayScale DirectColor
7903 PseudoColor visual id
7906 <p>The X server must support the visual you choose, otherwise an error occurs.
7907 If a visual is not specified, the visual class that can display the most
7908 simultaneous colors on the default screen is chosen.</p>
7911 <div style="margin: auto;">
7912 <h3><a class="anchor" id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7915 <p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7917 <p>Take a grayscale image (with alpha mask) and modify the destination image's
7918 brightness according to watermark image's grayscale value and the
7919 <var>brightness</var> percentage. The destinations color saturation
7920 attribute is just direct modified by the <var>saturation</var>
7921 percentage, which defaults to 100 percent (no color change). </p>
7924 <div style="margin: auto;">
7925 <h3><a class="anchor" id="wave"></a>-wave <var>amplitude</var><br />-wave <var>amplitude</var>x<var>wavelength</var></h3>
7928 <p class="magick-description">Shear the columns of an image into a sine wave.</p>
7930 <div style="margin: auto;">
7931 <h3><a class="anchor" id="wavelet-denoise"></a>-wavelet-denoise <var>threshold</var><br />-wavelet-denoise <var>threshold</var>x<var>softness</var></h3>
7934 <p class="magick-description">removes noise from the image using a wavelet transform. The threshold is the value below which everything is considered noise and ranges from 0.0 (none) to QuantumRange or use percent (e.g. 5%). Softness attenuates the threshold and typically ranges from 0.0 (none) to 1.0. The higher the value the more noise that remains in the image.</p>
7936 <div style="margin: auto;">
7937 <h3><a class="anchor" id="weight"></a>-weight <var>fontWeight</var></h3>
7940 <p class="magick-description">Set a font weight for text.</p>
7942 <p>This setting suggests a font weight that ImageMagick should try to apply to
7943 the currently selected font family. Use a positive integer for
7944 <var>fontWeight</var> or select from the following.</p>
7947 <dt class="col-md-4">Thin </dt>
7948 <dd class="col-md-8">Same as <var>fontWeight</var> = 100.</dd>
7949 <dt class="col-md-4">ExtraLight </dt>
7950 <dd class="col-md-8">Same as <var>fontWeight</var> = 200.</dd>
7951 <dt class="col-md-4">Light </dt>
7952 <dd class="col-md-8">Same as <var>fontWeight</var> = 300.</dd>
7953 <dt class="col-md-4">Normal </dt>
7954 <dd class="col-md-8">Same as <var>fontWeight</var> = 400.</dd>
7955 <dt class="col-md-4">Medium </dt>
7956 <dd class="col-md-8">Same as <var>fontWeight</var> = 500.</dd>
7957 <dt class="col-md-4">DemiBold </dt>
7958 <dd class="col-md-8">Same as <var>fontWeight</var> = 600.</dd>
7959 <dt class="col-md-4">Bold </dt>
7960 <dd class="col-md-8">Same as <var>fontWeight</var> = 700.</dd>
7961 <dt class="col-md-4">ExtraBold </dt>
7962 <dd class="col-md-8">Same as <var>fontWeight</var> = 800.</dd>
7963 <dt class="col-md-4">Heavy </dt>
7964 <dd class="col-md-8">Same as <var>fontWeight</var> = 900.</dd>
7968 <p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7970 <p>For other settings that affect fonts, see the options <a
7971 href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7972 href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
7974 <div style="margin: auto;">
7975 <h3><a class="anchor" id="white-point"></a>-white-point <var>x,y</var></h3>
7978 <p class="magick-description">chromaticity white point.</p>
7980 <div style="margin: auto;">
7981 <h3><a class="anchor" id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7984 <p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7986 <p> The threshold value can be given as a percentage or as an absolute integer
7987 value within [0, <var>QuantumRange</var>] corresponding to the
7988 desired <a href="command-line-options.html#channel">‑channel</a> value. See <a href="command-line-options.html#threshold">‑threshold</a>for more details on thresholds and resulting values. </p>
7990 <div style="margin: auto;">
7991 <h3><a class="anchor" id="window"></a>-window <var>id</var></h3>
7994 <p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7996 <p><var>id</var> can be a window id or name. Specify <code>root</code>
7997 to select X's root window as the target window.</p>
7999 <p>By default the image is tiled onto the background of the target window. If
8000 <code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
8001 image is surrounded by the background color. Refer to <code>X RESOURCES</code>
8004 <p>The image will not display on the root window if the image has more unique
8005 colors than the target window colormap allows. Use <a
8006 href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
8008 <div style="margin: auto;">
8009 <h3><a class="anchor" id="window-group"></a>-window-group</h3>
8012 <p class="magick-description">specify the window group.</p>
8014 <div style="margin: auto;">
8015 <h3><a class="anchor" id="write"></a>-write <var>filename</var></h3>
8018 <p class="magick-description">write an image sequence.</p>
8020 <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>
8022 <p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
8024 <div style="margin: auto;">
8025 <h3><a class="anchor" id="write-mask"></a>-write-mask <var>filename</var></h3>
8028 <p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
8030 <p>This the same as using a mask used for composite masking operations, with
8031 grayscale values causing blended updates of the image the mask is attached to.
8034 <p>Use <a href="command-line-options.html#write-mask">+write-mask</a> to remove the mask from images.</p>
8036 <p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
8037 but with strict boolean masking. </p>
8044 </main><!-- /.container -->
8045 <footer class="magick-footer">
8046 <p><a href="security-policy.html">Security</a> •
8047 <a href="architecture.html">Architecture</a> •
8048 <a href="links.html">Related</a> •
8049 <a href="sitemap.html">Sitemap</a>
8051 <a href="command-line-options.html#"><img class="d-inline" id="logo" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
8053 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
8054 <a href="support.html">Donate</a> •
8055 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a>
8057 <small>© 1999-2018 ImageMagick Studio LLC</small></p>
8060 <!-- Javascript assets -->
8061 <script src="assets/magick.js" crossorigin="anonymous"></script>
8062 <script>window.jQuery || document.write('<script src="assets/jquery.min.js"><\/script>')</script>
8065 <!-- Magick Cache 31st December 2017 14:35 -->
projects / imagemagick / blob