Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 29f2c97f63e6f5a9158d6ea44dc512e3fc70747e / . / www / command-line-options.html
blob: e3904b6a4479978047adaa7ba9cadbb1f18d29f1 [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]3<head>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]4 <title>ImageMagick: Command-line Options</title>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6 <meta name="application-name" content="ImageMagick">
7 <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.">
8 <meta name="application-url" content="http://www.imagemagick.org">
9 <meta name="generator" content="PHP">
10 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
11 <meta name="rating" content="GENERAL">
12 <meta name="robots" content="INDEX, FOLLOW">
13 <meta name="generator" content="ImageMagick Studio LLC">
14 <meta name="author" content="ImageMagick Studio LLC">
15 <meta name="revisit-after" content="2 DAYS">
16 <meta name="resource-type" content="document">
17 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
18 <meta name="distribution" content="Global">
19 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]20 <link href="../images/wand.png" rel="icon">
21 <link href="../images/wand.ico" type="images/x-icon" rel="shortcut icon">
22 <link href="../css/magick.html" rel="stylesheet">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]23</head>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]24<body>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]25<div class="main">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]26<div class="magick-masthead">
27 <div class="container">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]28 <script async src="http://localhost/pagead/js/adsbygoogle.js"></script>
29 <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-3129977114552745" data-ad-slot="6345125851" data-ad-format="auto"></ins>
30 <script>
31 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]32 </script>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]33 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]34 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]35 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]36 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
37 <a class="magick-nav-item active" href="command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]38 <a class="magick-nav-item " href="resources.html">Resources</a>
39 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]40 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]41 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]42 </nav>
43 </div>
44</div>
45<div class="container">
46<div class="magick-header">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]47<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#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#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-mas">‑read‑mas</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#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>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]48
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]49<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>
50
51<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]52 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]53</div>
54
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]55<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]56
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]57<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
58defaults to 1.</p>
59
60<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]61 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]62</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]63
64<p class="magick-description">Resize the image using data-dependent triangulation.</p>
65
66<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>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]67option defaults to data-dependent triangulation. Use the <a href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
68Offsets, if present in the geometry string, are ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]69
70<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]71 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]72</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]73
74<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
75
76<p>A Gaussian operator of the given radius and standard deviation
77(<var>sigma</var>) is used. If <var>sigma</var> is not given it
78defaults to 1.</p>
79
80<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]81 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]82</div>
83
84<p class="magick-description">Join images into a single multi-image file.</p>
85
86<p>This option is enabled by default. An attempt is made to save all images of
87an image sequence into the given output file. However, some formats, such as
88JPEG and PNG, do not support more than one image per file, and in that case
89ImageMagick is forced to write each image as a separate file. As such, if
90more than one image needs to be written, the filename given is modified by
91adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
92make distinct names for each image. </p>
93
94<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
95separate files, whether or not the file format allows multiple images per file
96(for example, GIF, MIFF, and TIFF). </p>
97
98<p>Including a C-style integer format string in the output filename will
99automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
100where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
101strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
102who have used the standard <code>printf()</code>' C-library function. As an
103example, the command</p>
104
105<pre>
106convert logo: rose: -morph 15 my%02dmorph.jpg
107</pre>
108
109<p>will create a sequence of 17 images (the two given plus 15 more created by
110<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
111my02morph.jpg, ..., my16morph.jpg. </p>
112
113<p>In summary, ImageMagick tries to write all images to one file, but will
114save to multiple files, if any of the following conditions exist...</p>
115<ol>
116<li>the output image's file format does not allow multi-image files,</li>
117<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
118<li>a printf() integer format string (eg: "%d") is present in the output
119 filename.</li>
120</ol>
121
122
123<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]124 <h3 class="magick-header"><a id="affine"></a>-affine
125 <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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]126</div>
127
128<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
129
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]130<p>This option sets a transformation matrix, for use by subsequent <a href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]131
132<p>The matrix entries are entered as comma-separated numeric values either in
133quotes or without spaces. </p>
134
135<p>Internally, the transformation matrix has 3x3 elements, but three of them
136are omitted from the input because they are constant. The new (transformed)
137coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
138position (<var>x</var>, <var>y</var>) in the original
139image are calculated using the following matrix equation.</p>
140
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]141<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"> </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]142
143<p> The size of the resulting image is that of the smallest rectangle that
144contains the transformed source image. The parameters
145<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
146subsequently shift the image pixels so that those that are moved out of the
147image area are cut off.</p>
148
149<p>The transformation matrix complies with the left-handed pixel coordinate
150system: positive <var>x</var> and <var>y</var> directions
151are rightward and downward, resp.; positive rotation is clockwise.</p>
152
153<p> If the translation coefficients <var>t<sub>x</sub></var> and
154<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
155four parameters suffice for rotation and scaling without translation.</p>
156
157<p>Scaling by the factors <var>s<sub>x</sub></var> and
158<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
159respectively, is accomplished with the following.</p>
160
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]161<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]162information </p>
163
164
165<pre>
166-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
167</pre>
168
169<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
170
171<pre>
172-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
173</pre>
174
175<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
176<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
177= sin(<var>a</var>), and using the following.</p>
178
179<pre>
180-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
181</pre>
182
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]183<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine">-affine</a>
184transformations can be accomplished by instead by a single <a href="command-line-options.html#affine">-affine</a> operation using the matrix equal to the product of the matrices
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]185of the individual transformations.</p>
186
187<p>An attempt is made to detect near-singular transformation matrices. If the
188matrix determinant has a sufficiently small absolute value it is rejected.</p>
189
190<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]191 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]192</div>
193
194<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
195
196<p>Used to set a flag on an image indicating whether or not to use existing alpha
197channel 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>
198
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]199<dl class="dl-horizontal">
200 <dt>Activate</dt>
201 <dd>
202 Enable the image's transparency channel. Note normally Set
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]203 should be used instead of this, unless you specifically need to
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]204 preserve existing (but specifically turned Off) transparency
205 channel. </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]206
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]207 <dt>Associate</dt>
208 <dd>
209 associate the alpha channel with the image.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]210
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]211 <dt>Deactivate</dt>
212 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]213 Disables the image's transparency channel. Does not delete or change the
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]214 existing data, just turns off the use of that data.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]215
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]216 <dt>Disassociate</dt>
217 <dd>
218 disassociate the alpha channel from the image.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]219
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]220 <dt>Set</dt>
221 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]222 Activates the alpha/matte channel. If it was previously turned off
223 then it also resets the channel to opaque. If the image already had
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]224 the alpha channel turned on, it will have no effect.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]225
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]226 <dt>Opaque</dt>
227 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]228 Enables the alpha/matte channel and forces it to be fully opaque.
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]229 </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]230
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]231 <dt>Transparent</dt>
232 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]233 Activates the alpha/matte channel and forces it to be fully
234 transparent. This effectively creates a fully transparent image the
235 same size as the original and with all its original RGB data still
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]236 intact, but fully transparent. </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]237
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]238 <dt>Extract</dt>
239 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]240 Copies the alpha channel values into all the color channels and turns
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]241 'Off' the the image's transparency, so as to generate
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]242 a gray-scale mask of the image's shape. The alpha channel data is left
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]243 intact just deactivated. This is the inverse of 'Copy'.
244 </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]245
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]246 <dt>Copy</dt>
247 <dd>
248 Turns 'On' the alpha/matte channel, then copies the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]249 gray-scale intensity of the image, into the alpha channel, converting
250 a gray-scale mask into a transparent shaped mask ready to be colored
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]251 appropriately. The color channels are not modified. </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]252
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]253 <dt>Shape</dt>
254 <dd>
255 As per 'Copy' but also colors the resulting shape mask with
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]256 the current background color. That is the RGB color channels is
257 replaced, with appropriate alpha shape.
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]258 </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]259
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]260 <dt>Remove</dt>
261 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]262 Composite the image over the background color.
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]263 </dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]264
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]265 <dt>Background</dt>
266 <dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]267 Set any fully-transparent pixel to the background color, while leaving
268 it fully-transparent. This can make some image file formats, such as
269 PNG, smaller as the RGB values of transparent pixels are more uniform,
270 and thus can compress better.
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]271 </dd>
272</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]273
274<p>Note that while the obsolete <code>+matte</code> operation was the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]275same as "<code><a href="command-line-options.html#alpha">-alpha</a> Off</code>", the <code>
276&gt;-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha">-alpha</a>
277Set</code>" and not "<code><a href="command-line-options.html#alpha">-alpha</a> On</code>". </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]278
279
280<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]281 <h3 class="magick-header"><a id="annotate"></a>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]282 -annotate <var>degrees</var> <var>text</var><br>
283 -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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]284</div>
285
286<p class="magick-description">Annotate an image with text</p>
287
288<p>This is a convenience for annotating an image with text. For more precise
289control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
290
291
292<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]293control 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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]294
295<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
296or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
297direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
298convention once it is realized that the positive <var>y</var>–direction is
299conventionally considered to be <var>downward</var> for images.)</p>
300
301<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
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]302equation.</p>
303
304<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]305
306<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
307bottom-left of the text becomes the upper-left corner of the image, which is
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]308probably undesirable. Adding a <a href="command-line-options.html#gravity">-gravity</a> option in this
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]309case leads to nice results.</p>
310
311<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
312is of the form '@mytext.txt', the text is read from the file
313<code>mytext.txt</code>. Text in a file is taken literally; no embedded
314formatting characters are recognized.</p>
315
316<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]317 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]318</div>
319
320<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
321
322<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
323drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
324antialiasing edge pixels. This will then reduce the number of colors added to
325an image to just the colors being directly drawn. That is, no mixed colors
326are added when drawing such objects. </p>
327
328<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]329 <h3 class="magick-header"><a id="append"></a>-append</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]330</div>
331
332<p class="magick-description">Join current images vertically or horizontally.</p>
333
334<p>This option creates a single longer image, by joining all the current
335images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
336stack images left-to-right. </p>
337
338<p>If they are not of the same width, narrower images are padded with the
339current <a href="command-line-options.html#background">-background</a> color setting, and their
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]340position relative to each other can be controlled by the current <a href="command-line-options.html#gravity">-gravity</a> setting. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]341
342
343<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]344 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]345</div>
346
347<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
348
349<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
350
351<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]352 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]353</div>
354
355<p class="magick-description">Decrypt a PDF with a password.</p>
356
357<p>Use this option to supply a <var>password</var> for decrypting
358a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
359encrypting using the MSC API is not supported.</p>
360
361<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
362and <a href="command-line-options.html#decipher">-decipher</a>. </p>
363
364
365<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]366 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]367</div>
368
369<p class="magick-description">Automagically adjust gamma level of image.</p>
370
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]371<p>This calculates the mean values of an image, then applies a calculated <a href="command-line-options.html#gamma">-gamma</a> adjustment so that is the mean color exists in the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]372image it will get a have a value of 50%. </p>
373
374<p>This means that any solid 'gray' image becomes 50% gray. </p>
375
376<p>This works well for real-life images with little or no extreme dark and
377light areas, but tend to fail for images with large amounts of bright sky or
378dark shadows. It also does not work well for diagrams or cartoon like images.
379</p>
380
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]381<p>It uses the <a href="command-line-options.html#channel">-channel</a> setting, (including the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]382'<var>sync</var>' flag for channel synchronization), to determine which color
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]383values is used and modified. As the default <a href="command-line-options.html#channel">-channel</a> setting is '<var>RGB,sync</var>', channels are modified
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]384together by the same gamma value, preserving colors. </p>
385
386
387
388<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]389 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]390</div>
391
392<p class="magick-description">Automagically adjust color levels of image.</p>
393
394<p>This is a 'perfect' image normalization operator. It finds the exact
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]395minimum and maximum color values in the image and then applies a <a href="command-line-options.html#level">-level</a> operator to stretch the values to the full range of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]396values. </p>
397
398<p>The operator is not typically used for real-life images, image scans, or
399JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]400for the <a href="command-line-options.html#level">-level</a> operation. On the other hand it is the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]401right operator to use for color stretching gradient images being used to
402generate Color lookup tables, distortion maps, or other 'mathematically'
403defined images. </p>
404
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]405<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch">-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
406problems that these operators may have. That is <a href="command-line-options.html#auto-level">-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]407
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]408<p>It uses the <a href="command-line-options.html#channel">-channel</a> setting, (including the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]409special '<var>sync</var>' flag for channel synchronization), to determine
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]410which color values are used and modified. As the default <a href="command-line-options.html#channel">+channel</a> setting is '<var>RGB,sync</var>', the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]411'<var>sync</var>' ensures that the color channels will are modified
412together by the same gamma value, preserving colors, and ignoring
413transparency. </p>
414
415
416<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]417 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]418</div>
419
420<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
421
422<p>This operator reads and resets the EXIF image profile setting 'Orientation'
423and then performs the appropriate 90 degree rotation on the image to orient
424the image, for correct viewing. </p>
425
426<p>This EXIF profile setting is usually set using a gravity sensor in digital
427camera, however photos taken directly downward or upward may not have an
428appropriate value. Also images that have been orientation 'corrected' without
429reseting this setting, may be 'corrected' again resulting in a incorrect
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]430result. If the EXIF profile was previously stripped, the <a href="command-line-options.html#auto-orient">-auto-orient</a> operator will do nothing. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]431
432
433<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]434 <h3 class="magick-header"><a id="average"></a>-average</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]435</div>
436
437<p class="magick-description">Average a set of images.</p>
438
439<p>An error results if the images are not identically sized.</p>
440
441
442<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]443 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]444</div>
445
446<p class="magick-description">Display the image centered on a backdrop.</p>
447
448<p>This backdrop covers the entire workstation screen and is useful for hiding
449other X window activity while viewing the image. The color of the backdrop is
450specified as the background color. The color is specified using the format
451described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
452
453<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]454 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]455</div>
456
457<p class="magick-description">Set the background color.</p>
458
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]459<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]460specified or found in the image) is white.</p>
461
462<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]463 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]464</div>
465
466<p class="magick-description">Measure performance.</p>
467
468<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
469consider the following command and its output. Modify the benchmark with the
470-duration to run the benchmark for a fixed number of seconds and -concurrent
471to run the benchmark in parallel (requires the OpenMP feature).</p>
472
473<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]474-&gt; convert logo: -resize 1000% -bench 5 logo.png
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]475Performance[4]: 5i 0.875657ips 6.880u 0:05.710
476</pre>
477
478<p>In this example, 5 iterations were completed at 0.875657 iterations per
479second, using 4 threads and 6.88 seconds of the user's allotted time, for
480a total elapsed time of 5.71 seconds.</p>
481
482<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]483 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]484</div>
485
486<p class="magick-description">Add bias when convolving an image.</p>
487
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]488<p>This option shifts the output of <a href="command-line-options.html#convolve">‑convolve</a> so that
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]489positive and negative results are relative to the specified bias value. </p>
490
491<p>This is important for non-HDRI compilations of ImageMagick when dealing
492with convolutions that contain negative as well as positive values. This is
493especially the case with convolutions involving high pass filters or edge
494detection. Without an output bias, the negative values are clipped at
495zero.</p>
496
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]497<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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]498negative results without clipping to the color value range
499(0..QuantumRange).</p>
500
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]501<p>See the discussion on HDRI implementations of ImageMagick on the page <a href="high-dynamic-range.html">High Dynamic-Range Images</a>. For more
502about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
503<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]504entry. </p>
505
506<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]507 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]508</div>
509
510<p class="magick-description">Use black point compensation.</p>
511
512<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]513 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]514</div>
515
516<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
517
518<p> The threshold value can be given as a percentage or as an absolute integer
519value within [0, <var>QuantumRange</var>] corresponding to the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]520desired <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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]521
522
523<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]524 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]525</div>
526
527<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
528
529<p>Blend will average the images together ('plus') according to the
530percentages given and each pixels transparency. If only a single percentage
531value is given it sets the weight of the composite or 'source' image, while
532the background image is weighted by the exact opposite amount. That is a
533<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
534'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
535
536
537<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]538 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]539</div>
540
541<p class="magick-description">Set the blue chromaticity primary point.</p>
542
543<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]544 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]545</div>
546
547<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
548
549<div style="margin: auto;">
550
551<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]552 <h3 class="magick-header"><a id="blur"></a>-blur <var>radius</var><br>-blur <var>radius</var>x<var>sigma</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]553</div>
554
555<p class="magick-description">Reduce image noise and reduce detail levels.</p>
556
557<p>Convolve the image with a Gaussian or normal distribution using the given
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]558<var>Sigma</var> value. The formula is:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]559
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]560<p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]561
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]562<p>The <var>Sigma</var> value is the important argument, and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]563determines the actual amount of blurring that will take place. </p>
564
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]565<p>The <var>Radius</var> is only used to determine the size of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]566array which will hold the calculated Gaussian distribution. It should be an
567integer. If not given, or set to zero, IM will calculate the largest possible
568radius that will provide meaningful results for the Gaussian distribution.
569</p>
570
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]571<p>The larger the <var>Radius</var> the slower the
572operation is. However too small a <var>Radius</var>, and sever
573aliasing effects may result. As a guideline, <var>Radius</var>
574should be at least twice the <var>Sigma</var> value, though three
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]575times will produce a more accurate result. </p>
576
577<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
578by taking advantage of the separability properties of the distribution. Here
579we apply a single-dimensional Gaussian matrix in the horizontal direction,
580then repeat the process in the vertical direction.</p>
581
582<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
583pixels which are outside the image proper are blurred into the final result.
584</p>
585
586
587<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]588 <h3 class="magick-header">-blur <var>Width</var>[x<var>Height</var>[+<var>Angle</var>]]</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]589</div>
590
591<p class="magick-description">Variably blur an image according to the overlay mapping.</p>
592
593<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
594Average (EWA) of the source image, scaled according to the grayscale
595mapping. </p>
596
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]597<p>The ellipse is weighted with sigma set to the given <var>Width</var> and <var>Height</var>. The <var>Height</var>
598defaults to the <var>Width</var> for a normal circular Gaussian
599weighting. The <var>Angle</var> will rotate the ellipse from
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]600horizontal clock-wise. </p>
601
602<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
603pixels which are outside the image proper are blurred into the final result.
604</p>
605
606
607<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]608 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]609</div>
610
611<p class="magick-description">Surround the image with a border of color. </p>
612
613<p>Set the width and height using the <var>size</var> portion of the
614<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
615ignored. </p>
616
617<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
618
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]619<dl class="dl-horizontal">
620<dt><var>value</var></dt>
621<dd>value is added to both left/right and top/bottom</dd>
622<dt><var>value-x</var><kbd>x</kbd></dt>
623<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
624<dt><kbd>x</kbd><var>value-y</var></dt>
625<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
626<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
627<dd>value-x is added to left/right and value-y added to top/bottom</dd>
628<dt><var>value-x</var><kbd>x</kbd>0</dt>
629<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
630<dt>0<kbd>x</kbd><var>value-y</var></dt>
631<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
632<dt><var>value</var>%</dt>
633<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
634<dt><var>value-x</var><kbd>x</kbd>%</dt>
635<dd>value-x % of width is added to left/right and to top/bottom</dd>
636<dt>x<var>value-y</var>%</dt>
637<dd>value-y % of height is added to top/bottom and to left/right</dd>
638<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
639<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
640<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
641<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
642<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
643<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
644</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]645
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]646<p>Set the border color by preceding with the <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]647
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]648<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]649'<code>Over</code>' composition method. It generates an image of the appropriate
650size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
651overlaying the original image in the center of this net image. This means that
652with the default compose method of '<code>Over</code>' any transparent parts may
653be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
654<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
655functionality.</p>
656
657<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]658 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]659</div>
660
661<p class="magick-description">Set the border color.</p>
662
663<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
664
665<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
666
667<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]668 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]669</div>
670
671<p class="magick-description">Set the border width.</p>
672
673<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]674 <h3 class="magick-header"><a id="brightness-contrast"></a>-brightness-contrast <var>brightness</var><br>-brightness-contrast <var>brightness</var>{x<var>contrast</var>}{<var>%</var>}}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]675</div>
676
677<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
678
679<p>Brightness and Contrast values apply changes to the input image. They are
680not absolute settings. A brightness or contrast value of zero means no change.
681The range of values is -100 to +100 on each. Positive values increase the
682brightness or contrast and negative values decrease the brightness or contrast.
683To control only contrast, set the brightness=0. To control only brightness,
684set contrast=0 or just leave it off.</p>
685
686<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
687apply the brightness and/or contrast change. The default is to apply the same
688transformation to all channels.</p>
689
690<p>Brightness and Contrast arguments are converted to offset and slope of a
691linear transform and applied
692using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
693
694<p>The slope varies from 0 at contrast=-100 to almost vertical at
695contrast=+100. For brightness=0 and contrast=-100, the result are totally
696midgray. For brightness=0 and contrast=+100, the result will approach but
697not quite reach a threshold at midgray; that is the linear transformation
698is a very steep vertical line at mid gray.</p>
699
700<p>Negative slopes, i.e. negating the image, are not possible with this
701function. All achievable slopes are zero or positive.</p>
702
703<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
704at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
705totally white. Similarly, when contrast=0 and brightness=-100, the result is
706totally black.</p>
707
708<p>As the range of values for the arguments are -100 to +100, adding the '%'
709symbol is no different than leaving it off.</p>
710
711<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]712 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]713</div>
714
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]715<p class="magick-description">(This option has been replaced by the <a href="command-line-options.html#limit">-limit</a> option).</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]716
717<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]718 <h3 class="magick-header"><a id="canny"></a>-canny <var>radius</var><br>-canny <var>radius</var>x<var>sigma</var>{<var>+lower-percent</var>}{<var>+upper-percent</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]719</div>
720
721<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
722
723<p>The thresholds range from 0 to 100% (e.g. -canny 0x1+10%+30%) with {<var>+lower-percent</var>} &lt; {<var>+upper-percent</var>}. If {<var>+upper-percent</var>} is increased but {<var>+lower-percent</var>} remains the same, lesser edge components will be detected, but their lengths will be the same. If {<var>+lower-percent</var>} is increased but {<var>+upper-percent</var>} is the same, the same number of edge components will be detected but their lengths will be shorter. The default thresholds are shown. The <var>radius</var>x<var>sigma</var> controls a gaussian blur applied to the input image to reduce noise and smooth the edges.</p>
724
725<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]726 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]727</div>
728
729<p class="magick-description">Assign a caption to an image.</p>
730
731<p>This option sets the caption meta-data of an image read in after this
732option has been given. To modify a caption of images already in memory use
733"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
734
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]735<p>The caption can contain special format characters listed in the <a href="escape.html">Format and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]736Print Image Properties</a>. These attributes are expanded when the caption
737is finally assigned to the individual images. </p>
738
739<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
740remaining characters in the string. Comments read in from a file are literal;
741no embedded formatting characters are recognized.</p>
742
743<p>Caption meta-data is not visible on the image itself. To do that use the
744<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
745instead.</p>
746
747<p>For example,</p>
748
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]749<pre>
750-caption "%m:%f %wx%h" bird.miff
751</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]752
753<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
754that the image <code>bird.miff</code> has a width of 512 and a height of
755480.</p>
756
757
758<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]759 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]760</div>
761
762<p class="magick-description">color correct with a color decision list.</p>
763
764<p>Here is an example color correction collection:</p>
765
766<pre>
767&lt;?xml version="1.0" encoding="UTF-8"?&gt;
768&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
769 &lt;ColorCorrection id="cc06668"&gt;
770 &lt;SOPNode&gt;
771 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
772 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
773 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
774 &lt;/SOPNode&gt;
775 &lt;SATNode&gt;
776 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
777 &lt;/SATNode&gt;
778 &lt;/ColorCorrection&gt;
779&lt;/ColorCorrectionCollection&gt;
780</pre>
781
782<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]783 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]784</div>
785
786<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
787
788<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
789<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
790<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
791<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
792<code>CMYKA</code>.</p>
793
794<p>The channels above can also be specified as a comma-separated list or can be
795abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
796'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
797'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
798
799For example, to only select the <code>Red</code> and <code>Blue</code> channels
800you can either use </p>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]801<pre>
802-channel Red,Blue
803</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]804<p>or you can use the short hand form</p>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]805<pre>
806-channel RB
807</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]808
809<p>All the channels that are present in an image can be specified using the
810special channel type <code>All</code>. Not all operators are 'channel capable',
811but generally any operators that are generally 'grey-scale' image operators,
812will understand this setting. See individual operator documentation. </p>
813
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]814<br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]815
816<p>On top of the normal channel selection an extra flag can be specified,
817'<code>Sync</code>'. This is turned on by default and if set means that
818operators that understand this flag should perform: cross-channel
819synchronization of the channels. If not specified, then most grey-scale
820operators will apply their image processing operations to each individual
821channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
822setting) completely independently from each other. </p>
823
824<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
825<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
826together in exactly the same way so that colors will remain in-sync. Without
827it being set, then each channel is modified separately and
828independently, which may produce color distortion. </p>
829
830<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
831and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
832the '<code>Sync</code>' flag to modify the behaviour of pixel colors according
833to the alpha channel (if present). That is to say it will modify the image
834processing with the understanding that fully-transparent colors should not
835contribute to the final result. </p>
836
837<p>Basically, by default, operators work with color channels in synchronous, and
838treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
839setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
840How each operator does this depends on that operators current implementation.
841Not all operators understands this flag at this time, but that is changing.
842</p>
843
844<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
845channel</a>.</p>
846
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]847<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
848'<code>RGBK,sync</code>', which specifies that operators act on all color
849channels except the transparency channel, and that all the color channels are
850to be modified in exactly the same way, with an understanding of transparency
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]851(depending on the operation being applied). The 'plus' form <a href="command-line-options.html#channel">+channel</a> will reset the value back to this default. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]852
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]853<p>Options that are affected by the <a href="command-line-options.html#channel">-channel</a> setting
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]854include the following.
855
856<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
857<a href="command-line-options.html#auto-level">-auto-level</a>,
858<a href="command-line-options.html#black-threshold">-black-threshold</a>,
859<a href="command-line-options.html#blur">-blur</a>,
860<a href="command-line-options.html#clamp">-clamp</a>,
861<a href="command-line-options.html#clut">-clut</a>,
862<a href="command-line-options.html#combine">-combine</a>,
863<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
864<a href="command-line-options.html#convolve">-convolve</a>,
865<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
866<a href="command-line-options.html#evaluate">-evaluate</a>,
867<a href="command-line-options.html#function">-function</a>,
868<a href="command-line-options.html#fx">-fx</a>,
869<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
870<a href="command-line-options.html#hald-clut">-hald-clut</a>,
871<a href="command-line-options.html#motion-blur">-motion-blur</a>,
872<a href="command-line-options.html#morphology">-morphology</a>,
873<a href="command-line-options.html#negate">-negate</a>,
874<a href="command-line-options.html#normalize">-normalize</a>,
875<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
876<a href="command-line-options.html#radial-blur">-radial-blur</a>,
877<a href="command-line-options.html#random-threshold">-random-threshold</a>,
878<a href="command-line-options.html#separate">-separate</a>,
879<a href="command-line-options.html#threshold">-threshold</a>, and
880<a href="command-line-options.html#white-threshold">-white-threshold</a>.
881</p>
882
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]883<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel">+channel</a> default setting is in effect, verses ANY user defined <a href="command-line-options.html#channel">-channel</a> setting (including the equivalent of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]884default). These operators have yet to be made to understand the newer 'Sync'
885flag. </p>
886
887<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default gray-scale
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]888the image before thresholding, if no <a href="command-line-options.html#channel">-channel</a> setting
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]889has been defined. This is not 'Sync flag controlled, yet. </p>
890
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]891<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
892color channels if the '<code>alpha</code>' channel is also enabled by <a href="command-line-options.html#channel">-channel</a>. Generally this done to ensure that
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]893fully-transparent colors are treated as being fully-transparent, and thus any
894underlying 'hidden' color has no effect on the final results. Typically
895resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
896convolution equivalents however does have a understanding of the 'Sync' flag
897and will thus handle transparency correctly by default. </p>
898
899<p>As a alpha channel is optional within images, some operators will read the
900color channels of an image as a greyscale alpha mask, when the image has no
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]901alpha channel present, and the <a href="command-line-options.html#channel">-channel</a> setting tells
902the operator to apply the operation using alpha channels. The <a href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]903
904
905
906<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]907 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]908</div>
909
910<p class="magick-description">Simulate a charcoal drawing.</p>
911
912<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]913 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]914</div>
915
916<p class="magick-description">Remove pixels from the interior of an image.</p>
917
918<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>
919and <var>height</var> given in the of the <var>size</var>
920portion of the <var>geometry</var> argument give the number of
921columns and rows to remove. The <var>offset</var> portion of
922the <var>geometry</var> argument is influenced by
923a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
924
925<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
926and moves the remaining corner blocks leftward and upward to close the gaps.</p>
927
928<p>While it can remove internal rows and columns of pixels, it is more
929typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]930offsets so as to remove a single edge from an image. Compare this to <a href="command-line-options.html#shave">-shave</a> which removes equal numbers of pixels from oppisite
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]931sides of the image. </p>
932
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]933<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a 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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]934
935<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]936 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]937</div>
938
939<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>
940
941<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]942 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]943</div>
944
945<p class="magick-description">Apply the clipping path if one is present.</p>
946
947<p>If a clipping path is present, it is applied to subsequent operations.</p>
948
949<p>For example, in the command</p>
950
951<pre>
952convert cockatoo.tif -clip -negate negated.tif
953</pre>
954
955<p>only the pixels within the clipping path are negated.</p>
956
957<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
958delegate library is not present, the option is ignored.</p>
959
960<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
961
962<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]963 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]964</div>
965
966<p class="magick-description">Clip the image as defined by this mask.</p>
967
968<p>Use the alpha channel of the current image as a mask. Any areas that is
969white is not modified by any of the 'image processing operators' that follow,
970until the mask is removed. Pixels in the black areas of the clip mask are
971modified per the requirements of the operator. </p>
972
973<p>In some ways this is similar to (though not the same) as defining
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]974a rectangular <a href="command-line-options.html#region">-region</a>, or using the negative of the
975mask (third) image in a three image <a href="command-line-options.html#composite">-composite</a>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]976operation. </p>
977
978<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
979
980<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]981 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]982</div>
983
984<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
985
986<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>
987
988<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
989
990<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]991 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]992</div>
993
994<p class="magick-description">make a clone of an image (or images).</p>
995
996<p>Inside parenthesis (where the operator is normally used) it will make a
997clone of the images from the last 'pushed' image sequence, and adds them to
998the end of the current image sequence. Outside parenthesis
999(not recommended) it clones the images from the current image sequence. </p>
1000
1001<p>Specify the image by its index in the sequence. The first image is index
10020. Negative indexes are relative to the end of the sequence; for
1003example, <code>−1</code>
1004represents the last image of the sequence. Specify a range of images with a
1005dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1006spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1007effectively clone all the images. </p>
1008
1009<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1010in the image sequence, and is thus equivalent to using a argument of
1011'<code>−1</code>'. </p>
1012
1013<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1014 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1015</div>
1016
1017<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>
1018
1019<p>The second (LUT) image is ordinarily a gradient image containing the
1020histogram mapping of how each channel should be modified. Typically it is a
1021either a single row or column image of replacement color values. If larger
1022than a single row or column, values are taken from a diagonal line from
1023top-left to bottom-right corners.</p>
1024
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1025<p>The lookup is further controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1026LUT which is not the full length needed by the ImageMagick installed Quality
1027(Q) level. Good settings for this are the '<code>bilinear</code>' and
1028'<code>bicubic</code>' interpolation settings, which give smooth color
1029gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1030lookup of color values. </p>
1031
1032<p>This operator is especially suited to replacing a grayscale image with a
1033specific color gradient from the CLUT image. </p>
1034
1035<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1036setting will have their values replaced. In particular, since the default <a href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1037transparency (alpha/matte channel) is not affected, unless the <a href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1038set, it is treated by the <a href="command-line-options.html#clut">-clut</a> operator in the same way
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1039as the other channels, implying that alpha/matte values are replaced using the
1040alpha/matte values of the original image. </p>
1041
1042<p>If either the image being modified, or the lookup image, contains no
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1043transparency (i.e. <a href="command-line-options.html#alpha">-alpha</a> is turned 'off') but the <a href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1044assumed that image represents a gray-scale gradient which is used for the
1045replacement alpha values. That is you can use a gray-scale CLUT image to
1046adjust a existing images alpha channel, or you can color a gray-scale image
1047using colors form CLUT containing the desired colors, including transparency.
1048</p>
1049
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1050<p>See also <a href="command-line-options.html#hald-clut">-hald-clut</a> which replaces colors
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1051according to the lookup of the full color RGB value from a 2D representation
1052of a 3D color cube. </p>
1053
1054
1055<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1056 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1057</div>
1058
1059<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1060
1061<p>Overlay each image in an image sequence according to
1062its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1063an animation at each point in the animation sequence. All images should be
1064the same size, and are assigned appropriate GIF disposal settings for the
1065animation to continue working as expected as a GIF animation. Such frames
1066are more easily viewed and processed than the highly optimized GIF overlay
1067images. </p>
1068
1069<p>The animation can be re-optimized after processing using
1070the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1071there is no guarantee that the restored GIF animation optimization is
1072better than the original. </p>
1073
1074
1075<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1076 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1077</div>
1078
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1079<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1080
1081<p>Specify the amount of colorization as a percentage. Separate colorization
1082values can be applied to the red, green, and blue channels of the image with
1083a comma-delimited list of colorization
1084values (e.g., <code>-colorize 0,0,50</code>).</p>
1085
1086<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1087 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1088</div>
1089
1090<p class="magick-description">Define the colormap type.</p>
1091
1092<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1093
1094<p>This option only applies when the default X server visual
1095is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1096to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1097a shared colormap is allocated. The image shares colors with
1098other X clients. Some image colors could be approximated,
1099therefore your image may look very different than intended.
1100If <code>private</code> is chosen, the image colors appear exactly
1101as they are defined. However, other clients may go <var>technicolor</var>
1102when the image colormap is installed.</p>
1103
1104<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1105 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1106</div>
1107
1108<p class="magick-description">Set the preferred number of colors in the image.</p>
1109
1110<p>The actual number of colors in the image may be less than your request,
1111but never more. Note that this a color reduction option. Images with fewer
1112unique colors than specified by <var>value</var> will have any
1113duplicate or unused colors removed. The ordering of an existing color
1114palette may be altered. When converting an image from color to grayscale,
1115it is more efficient to convert the image to the gray colorspace before
1116reducing the number of colors. Refer to
1117the <a href="quantize.html">
1118color reduction algorithm</a> for more details.</p>
1119
1120<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1121 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1122</div>
1123
1124<p class="magick-description">apply color correction to the image.</p>
1125
1126<p>This option permits saturation changes, hue rotation, luminance to alpha,
1127and various other effects. Although variable-sized transformation matrices
1128can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1129for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1130Adobe Flash except offsets are in column 6 rather than 5 (in support of
1131CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1132
1133<p>As an example, to add contrast to an image with offsets, try this command:</p>
1134
1135<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1136convert kittens.jpg -color-matrix \
1137 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1138 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1139 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1140 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1141 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1142 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1143</pre>
1144<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1145 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1146</div>
1147
1148<p class="magick-description">Set the image colorspace.</p>
1149
1150<p>Choices are:</p>
1151
1152<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1153CMY CMYK Gray HCL
1154HCLp HSB HSI HSL
1155HSV HWB Lab LCHab
1156LCHuv LMS Log Luv
1157OHTA Rec601YCbCr Rec709YCbCr RGB
1158scRGB sRGB Transparent xyY
1159XYZ YCbCr YCC YDbDr
1160YIQ YPbPr YUV
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1161</pre>
1162
1163<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1164
1165<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>
1166
1167<table class="table table-condensed table-striped">
1168 <caption>Conversion of RGB to Other Color Spaces</caption>
1169 <tr><th valign="middle">CMY</th></tr>
1170 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1171 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1172 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1173 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1174 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1175 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1176 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1177 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1178
1179 <tr><th valign="middle">Gray</th></tr>
1180 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1181
1182 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1183 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1184 <tr><td valign="middle">S=distance from axis outward</td></tr>
1185 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1186
1187 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1188 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1189 <tr><td valign="middle">S=distance from axis outward</td></tr>
1190 <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>
1191
1192 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1193 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1194 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1195 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1196
1197 <tr><th valign="middle">LAB</th></tr>
1198 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1199 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1200 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1201
1202 <tr><th valign="middle">LOG</th></tr>
1203 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1204 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1205 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1206
1207 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1208 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1209 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1210 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1211
1212 <tr><th valign="middle">Rec601Luma</th></tr>
1213 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1214
1215 <tr><th valign="middle">Rec601YCbCr</th></tr>
1216 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1217 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1218 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1219
1220 <tr><th valign="middle">Rec709Luma</th></tr>
1221 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1222
1223 <tr><th valign="middle">Rec709YCbCr</th></tr>
1224 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1225 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1226 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1227
1228 <tr><th valign="middle">sRGB</th></tr>
1229 <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>
1230 <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>
1231 <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>
1232
1233 <tr><th valign="middle">XYZ</th></tr>
1234 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1235 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1236 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1237
1238 <tr><th valign="middle">YCC</th></tr>
1239 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1240 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1241 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1242
1243 <tr><th valign="middle">YCbCr</th></tr>
1244 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1245 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1246 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1247
1248 <tr><th valign="middle">YIQ</th></tr>
1249 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1250 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1251 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1252
1253 <tr><th valign="middle">YPbPr</th></tr>
1254 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1255 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1256 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1257
1258 <tr><th valign="middle">YUV</th></tr>
1259 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1260 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1261 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1262</table>
1263
1264<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1265
1266<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1267 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1268</div>
1269
1270<p class="magick-description">Combine one or more images into a single image.</p>
1271
1272<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1273combined image are taken from the grayscale values of each image in the
1274sequence, in order. For the default -channel setting of <code>RGB</code>, this
1275means the first image is assigned to the <code>Red</code> channel, the second
1276to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1277
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1278<p>This option can be thought of as the inverse to <a href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1279Thus, in the following example, the final image should be a copy of the
1280original. </p>
1281
1282<pre>
1283convert original.png -channel RGB -separate sepimage.png
1284convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1285 -combine imagecopy.png
1286</pre>
1287
1288<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1289 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1290</div>
1291
1292<p class="magick-description">Embed a comment in an image.</p>
1293
1294<p>This option sets the comment meta-data of an image read in after this
1295option has been given. To modify a comment of images already in memory use
1296"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1297
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1298<p>The comment can contain special format characters listed in the <a href="escape.html">Format and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1299Print Image Properties</a>. These attributes are expanded when the comment
1300is finally assigned to the individual images. </p>
1301
1302<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1303remaining characters in the string. Comments read in from a file are literal;
1304no embedded formatting characters are recognized.</p>
1305
1306<p>Comment meta-data are not visible on the image itself. To do that use the
1307<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1308instead.</p>
1309
1310<p>For example,</p>
1311
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1312<pre>
1313-comment "%m:%f %wx%h" bird.miff
1314</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1315
1316<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1317that the image <code>bird.miff</code> has a width of 512 and a height of
1318480.</p>
1319
1320<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1321 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1322</div>
1323
1324<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1325
1326<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>
1327
1328<pre>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1329convert image.png reference.png -metric RMSE -compare \ <br> difference.png
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1330</pre>
1331
1332<p>To get the metric value use the string format "%[distortion]".</p>
1333
1334<pre>
1335convert image.png reference.png -metric RMSE -compare -format \
1336 "%[distortion]" info:
1337</pre>
1338
1339<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1340 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1341</div>
1342
1343<p class="magick-description">perform complex mathematics on an image sequence</p>
1344
1345Choose from these operators:
1346
1347<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1348add
1349conjugate
1350divide
1351magnuitude-phase
1352multiply
1353real-imaginary
1354subtract
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1355</pre>
1356
1357<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>
1358
1359<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1360 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1361</div>
1362
1363<p class="magick-description">Set the type of image composition.</p>
1364
1365<p>See <a href="compose.html">Alpha Compositing</a> for
1366a detailed discussion of alpha compositing.</p>
1367
1368<p>This setting effects image processing operators that merge two (or more)
1369images together in some way. This includes the operators,
1370<a href="command-line-options.html#composite">-compare</a>,
1371<a href="command-line-options.html#composite">-composite</a>,
1372<a href="command-line-options.html#layers">-layers</a> composite,
1373<a href="command-line-options.html#flatten">-flatten</a>,
1374<a href="command-line-options.html#mosaic">-mosaic</a>,
1375<a href="command-line-options.html#layers">-layers</a> merge,
1376<a href="command-line-options.html#border">-border</a>,
1377<a href="command-line-options.html#frame">-frame</a>,
1378and <a href="command-line-options.html#extent">-extent</a>. </p>
1379
1380<p>It is also one of the primary options for the "<code>composite</code>"
1381command. </p>
1382
1383
1384<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1385 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1386</div>
1387
1388<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1389
1390<p>Take the first image 'destination' and overlay the second 'source' image
1391according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1392of the 'source' or 'overlay' image is controlled according to <a href="command-line-options.html#geometry">-geometry</a>, and <a href="command-line-options.html#geometry">-geometry</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1393settings. </p>
1394
1395<p>If a third image is given this is treated as a gray-scale blending 'mask' image
1396relative to the first 'destination' image. This mask is blended with the
1397source image. However for the '<code>displace</code>' compose method, the
1398mask is used to provide a separate Y-displacement image instead. </p>
1399
1400<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1401arguments or flags these can be provided by setting the <a href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1402appropriately for the compose method. </p>
1403
1404<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1405image outside the overlay area. You can disable this by setting the special <a href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1406to '<code>false</code>'. </p>
1407
1408<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>
1409
1410
1411<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1412 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1413</div>
1414
1415<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1416
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1417<p>Choices are: <code>None</code>, <code>BZip</code>, <code>Fax</code>, <code>Group4</code>, <code>JPEG</code>, <code>JPEG2000</code>, <code>Lossless</code>, <code>LZW</code>, <code>RLE</code> or <code>Zip</code>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1418
1419<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1420compress</a>.</p>
1421
1422<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1423uncompressed format. The default is the compression type of the specified
1424image file.</p>
1425
1426<p>If <code>LZW</code> compression is specified but LZW compression has not been
1427enabled, the image data is written in an uncompressed LZW format that can be
1428read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1429
1430<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1431JPEG library has been patched to support it. Use of lossless JPEG is generally
1432not recommended.</p>
1433
1434<p>
1435When writing an ICO file, you may request that the images be encoded in
1436PNG format, by specifying <code>Zip</code> compression.</p>
1437
1438<p>
1439When writing a JNG file, specify <code>Zip</code> compression to request that
1440the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1441to request that it be encoded in JPG "JDAA" format.</p>
1442
1443<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1444to be used by JPEG, PNG, MIFF, and MPEG encoders.
1445Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1446sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1447the chroma channels.</p>
1448
1449<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1450 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1451</div>
1452
1453<p class="magick-description">connected-components uniquely labeled, choose from 4 or 8 way connectivity.</p>
1454
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1455<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1456
1457<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1458 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1459</div>
1460
1461<p class="magick-description">Enhance or reduce the image contrast.</p>
1462
1463<p>This option enhances the intensity differences between the lighter and
1464darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1465the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1466contrast.</p>
1467
1468<p>For a more pronounced effect you can repeat the option:</p>
1469
1470<pre>
1471convert rose: -contrast -contrast rose_c2.png
1472</pre>
1473
1474<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1475 <h3 class="magick-header"><a id="contrast-stretch"></a>-contrast-stretch <var>black-point</var><br>-contrast-stretch <var>black-point</var>{x<var>white-point</var>}{<var>%</var>}}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1476</div>
1477
1478<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1479
1480<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
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1481<var>black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1482
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1483<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> will black-out at most <var>black-point</var> pixels and white-out at most <var>total pixels
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1484minus 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>
1485
1486<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1487the 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
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1488clipping at either end. This is not the same as <a href="command-line-options.html#normalize">-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1489prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1490
1491<p>Internally operator works by creating a histogram bin, and then uses that
1492bin to modify the image. As such some colors may be merged together when they
1493originally fell into the same 'bin'. </p>
1494
1495<p>All the channels are normalized in concert by the came amount so as to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1496preserve color integrity, when the default <a href="command-line-options.html#channel">+channel</a>
1497setting is in use. Specifying any other <a href="command-line-options.html#channel">-channel</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1498setting will normalize the RGB channels independently.</p>
1499
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1500<p>See also <a href="command-line-options.html#auto-level">-auto-level</a> for a 'perfect'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1501normalization of mathematical images. </p>
1502
1503<p>This operator is under review for re-development. </p>
1504
1505
1506<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1507 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1508</div>
1509
1510<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1511
1512<p>The <var>kernel</var> is a matrix specified as
1513a comma-separated list of integers (with no spaces), ordered left-to right,
1514starting with the top row. Presently, only odd-dimensioned kernels are
1515supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15167<sup>2</sup>=49, etc. </p>
1517
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1518<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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1519positive and negative results are relative to a user-specified bias value.
1520This is important for non-HDRI compilations of ImageMagick when dealing with
1521convolutions that contain negative as well as positive values. This is
1522especially the case with convolutions involving high pass filters or edge
1523detection. Without an output bias, the negative values is clipped at zero.
1524</p>
1525
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1526<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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1527negative results without clipping to the color value range (0..QuantumRange).
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1528See the discussion on HDRI implementations of ImageMagick on the page <a href="high-dynamic-range.html">High
1529Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1530<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1531entry. </p>
1532
1533
1534<div style="margin: auto;">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]1535 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1536</div>
1537
1538<p class="magick-description">copy pixels from one area of an image to another.</p>
1539
1540<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1541 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1542</div>
1543
1544<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1545
1546<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1547
1548<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1549after cropping, and <var>x</var> and <var>y</var> in the
1550<var>offset</var> (if present) gives the location of the top left
1551corner of the cropped image with respect to the original image. To specify the
1552amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1553
1554<p>If the <var>x</var> and <var>y</var> offsets are
1555present, a single image is generated, consisting of the pixels from the
1556cropping region. The offsets specify the location of the upper left corner of
1557the cropping region measured downward and rightward with respect to the upper
1558left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1559present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1560gravity, it gives the distance leftward from the right edge of the image to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1561the right edge of the cropping region. Similarly, if the <a href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1562<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1563upward between the bottom edges.</p>
1564
1565<p>If the <var>x</var> and <var>y</var> offsets are
1566omitted, a set of tiles of the specified geometry, covering the entire input
1567image, is generated. The rightmost tiles and the bottom tiles are smaller if
1568the specified geometry extends beyond the dimensions of the input image.</p>
1569
1570<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1571
1572<p>By adding a exclamation character flag to the geometry argument, the
1573cropped images virtual canvas page size and offset is set as if the
1574geometry argument was a viewport or window. This means the canvas page size
1575is set to exactly the same size you specified, the image offset set
1576relative top left corner of the region cropped. </p>
1577
1578<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1579special single pixel transparent 'missed' image is returned, and a 'crop
1580missed' warning given. </p>
1581
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1582<p>It might be necessary to <a href="command-line-options.html#repage">+repage</a> the image prior to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1583cropping the image to ensure the crop coordinate frame is relocated to the
1584upper-left corner of the visible image.
1585
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1586Similarly you may want to use <a href="command-line-options.html#repage">+repage</a> after cropping to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1587remove the page offset that will be left behind. This is especially true when
1588you are going to write to an image format such as PNG that supports an image
1589offset.</p>
1590
1591<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1592 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1593</div>
1594
1595<p class="magick-description">displace image colormap by amount.</p>
1596
1597<p><var>Amount</var> defines the number of positions each
1598colormap entry is shifted.</p>
1599
1600
1601<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1602 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1603</div>
1604
1605<p class="magick-description">enable debug printout.</p>
1606
1607<p>The <code>events</code> parameter specifies which events are to be logged. It
1608can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1609a comma-separated list consisting of one or more of the following domains:
1610<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1611<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1612<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1613<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1614<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1615
1616
1617<p>For example, to log cache and blob events, use.</p>
1618
1619<pre>
1620convert -debug "Cache,Blob" rose: rose.png
1621</pre>
1622
1623<p>The <code>User</code> domain is normally empty, but developers can log user
1624events in their private copy of ImageMagick.</p>
1625
1626<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1627debug</a>.</p>
1628
1629<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1630output.</p>
1631
1632<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1633
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1634<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment">environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1635environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1636option.</p>
1637
1638
1639<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1640 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1641</div>
1642
1643<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1644
1645<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1646
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]1647<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1648Decipher an Image</a>.</p>
1649
1650
1651<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1652 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1653</div>
1654
1655<p class="magick-description">find areas that has changed between images </p>
1656
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1657<p>Given a sequence of images all the same size, such as produced by <a href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1658a smaller image of just the area that changed relative to the previous image.
1659</p>
1660
1661<p>The resulting sequence of images can be used to optimize an animation
1662sequence, though will not work correctly for GIF animations when parts of the
1663animation can go from opaque to transparent. </p>
1664
1665<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1666method '<code>compare-any</code>'. </p>
1667
1668
1669<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1670 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1671</div>
1672
1673<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1674
1675<p>This option creates one or more definitions for coders and decoders to use
1676while reading and writing image data. Definitions are generally used to
1677control image file format coder modules, and image processing operations,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1678beyond what is provided by normal means. Defined settings are listed in <a href="command-line-options.html#verbose">-verbose</a> information ("<code>info:</code>" output format)
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1679as "Artifacts". </p>
1680
1681<p>If <var>value</var> is missing for a definition, an empty-valued
1682definition of a flag is created with that name. This used to control on/off
1683options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1684previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1685existing definitions.</p>
1686
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1687<p>The same 'artifact' settings can also be defined using the <a 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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1688Properties</a> in the defined value. </p>
1689
1690<p>The <var>option</var> and <var>key</var> are case-independent (they are
1691converted to lowercase for use within the decoders) while the <var>value</var>
1692is case-dependent.</p>
1693
1694<p>Such settings are global in scope, and affect all images and operations. </p>
1695
1696<p>The following definitions are just some of the artifacts that are
1697available:</p>
1698
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1699<table class="table table-condensed table-striped">
1700 <tr>
1701 <td>bmp:format=<var>value</var></td>
1702 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1703 and <var>bmp4</var>. This option can be useful when the
1704 method of prepending "BMP2:" to the output filename is inconvenient or
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1705 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1706 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1707
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1708 <tr>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]1709 <td>colorspace:auto-grayscale=<var>on|off</var></td>
1710 <td>prevent automatic conversion to grayscale inside coders that support grayscale.</td>
1711 </tr>
1712
1713 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1714 <td>complex:snr=<var>value</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1715 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1716 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1717
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1718 <tr>
1719 <td>compose:args=<var>arguments</var></td>
1720 <td>Sets certain compose argument values when using convert ... -compose ...
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]1721 -composite. See <a href="http://www.imagemagick.org/www/compose.html">Image Composition</a></td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1722 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1723
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1724 <tr>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]1725 <td>compose:clamp=<var>on|off</var></td>
1726 <td>set each pixel whose value is below zero to zero and any the pixel whose value is above the quantum range to the quantum range (e.g. 65535) otherwise the pixel value remains unchanged. Define supported in ImageMagick 6.9.1-3 and above.</td>
1727 </tr>
1728
1729 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1730 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1731 <td>Defines the kernel scaling. The special flag ! automatically scales to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1732 full dynamic range. The ! flag can be used in combination with a factor or
1733 percent. The factor or percent is then applied after the automatic scaling.
1734 An example is 50%!. This produces a result 50% darker than full dynamic
1735 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1736 example when some values are positive and some are negative as in edge
1737 detection kernels. The origin addition adds that value to the center
1738 pixel of the kernel. This produces and effect that is like adding the image
1739 that many times to the result of the filtered image. The typical value
1740 is 1 so that the original image is added to the result of the convolution.
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1741 The default is 0.</td>
1742 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1743
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1744 <tr>
1745 <td>convolve:showkernel=<var>1</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1746 <td>Outputs (to 'standard error') all the information about a specified <a href="command-line-options.html#morphology">-morphology convolve</a> kernel.</td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1747 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1748
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1749 <tr>
1750 <td>dcm:display-range=<var>reset</var></td>
1751 <td>Sets the display range to the minimum and maximum pixel values for the
1752 DCM image format.</td>
1753 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1754
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1755 <tr>
1756 <td>dds:cluster-fit=<var>true|false</var></td>
1757 <td>Enables the dds cluster-fit.</td>
1758 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1759
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1760 <tr>
1761 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1762 <td>Sets the dds compression.</td>
1763 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1764
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1765 <tr>
1766 <td>dds:mipmaps=<var>value</var></td>
1767 <td>Sets the dds number of mipmaps.</td>
1768 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1769
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1770 <tr>
1771 <td>dds:weight-by-alpha=<var>true|false</var></td>
1772 <td>Enables the dds alpha weighting.</td>
1773 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1774
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1775 <tr>
1776 <td>delegate:bimodal=<var>true</var></td>
1777 <td>Specifies direct conversion from Postscript to PDF.</td>
1778 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1779
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1780 <tr>
1781 <td>distort:scale=<var>value</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1782 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort">-distort</a></td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1783 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1784
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1785 <tr>
1786 <td>distort:viewport=<var>WxH+X+Y</var></td>
1787 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1788 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1789
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1790 <tr>
1791 <td>dot:layout-engine=<var>value</var></td>
1792 <td>Specifies the layout engine for the DOT image format (e.g.
1793 <code>neato</code>).</td>
1794 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1795
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1796 <tr>
1797 <td>filter:option=<var>value</var></td>
1798 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1799 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1800 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1801
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1802 <tr>
1803 <td>fourier:normalize=<var>inverse</var></td>
1804 <td>Sets the location for the FFT/IFT normalization as use by
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1805 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1806 forward.</td>
1807 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1808
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1809 <tr>
1810 <td>icon:auto-resize</td>
1811 <td>Automatically stores multiple sizes when writing an ico image
1812 (requires a 256x256 input image).</td>
1813 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1814
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1815 <tr>
1816 <td>jp2:layer-number=<var>value</var></td>
1817 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1818 and J2K</td>
1819 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1820
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1821 <tr>
1822 <td>jp2:number-resolutions=<var>value</var></td>
1823 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and J2K</td>
1824 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1825
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1826 <tr>
1827 <td>jp2:progression-order=<var>value</var></td>
1828 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1829 J2K</td>
1830 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1831
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1832 <tr>
1833 <td>jp2:quality=<var>value,value...</var></td>
1834 <td>Sets the quality layer PSNR, given in dB. The order is from left to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1835 right in ascending order. The default is a single lossless quality layer.
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1836 Same for JPT, JC2, and J2K</td>
1837 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1838
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1839 <tr>
1840 <td>jp2:rate=<var>value</var></td>
1841 <td>Specify the compression factor to use while writing JPEG-2000 files. The
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1842 compression factor is the reciprocal of the compression ratio. The valid
1843 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1844 this value overrides the -quality setting. A quality setting of 75
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1845 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
1846 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1847
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1848 <tr>
1849 <td>jp2:reduce-factor=<var>value</var></td>
1850 <td>Sets the number of highest resolution levels to be discarded.Same for
1851 JPT, JC2, and J2K</td>
1852 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1853
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1854 <tr>
1855 <td>jpeg:block-smoothing=<var>on|off</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1856 <td>&amp;nbsp</td>
1857 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1858
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1859 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1860 <td>jpeg:colors=<var>value</var></td>
1861 <td>Set the desired number of colors and let the JPEG encoder do the
1862 quantizing.</td>
1863 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1864
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1865 <tr>
1866 <td>jpeg:dct-method=<var>value</var></td>
1867 <td>Choose from <code>default</code>, <code>fastest</code>,
1868 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
1869 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1870
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1871 <tr>
1872 <td>jpeg:extent=<var>value</var></td>
1873 <td>Restrict the maximum JPEG file size, for example <code>-define
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1874 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
1875 compression quality level that results in an output file that does not
1876 exceed the value. The <code>-quality</code> option is ignored if it
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1877 is also present.</td>
1878 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1879
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1880 <tr>
1881 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1882 <td>&amp;nbsp</td>
1883 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1884
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1885 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1886 <td>jpeg:optimize-coding=<var>on|off</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1887 <td>&amp;nbsp</td>
1888 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1889
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1890 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1891 <td>jpeg:q-table=<var>table</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1892 <td>&amp;nbsp</td>
1893 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1894
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1895 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1896 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1897 <td>&amp;nbsp</td>
1898 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1899
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1900 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1901 <td>jpeg:size=<var>geometry</var></td>
1902 <td>Set the size hint of a JPEG image, for
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1903 example, <code>-define jpeg:size=128x128</code>.
1904 It is most useful for increasing performance and reducing the memory
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1905 requirements when reducing the size of a large JPEG image.</td>
1906 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1907
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1908 <tr>
1909 <td>json:features</td>
1910 <td>includes features in verbose information</td>
1911 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1912
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1913 <tr>
1914 <td>json:limit</td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1915 <td>&amp;nbsp</td>
1916 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1917
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1918 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1919 <td>json:locate</td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1920 <td>&amp;nbsp</td>
1921 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1922
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1923 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1924 <td>json:moments</td>
1925 <td>includes image moments in verbose information</td>
1926 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1927
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1928 <tr>
1929 <td>mng:need-cacheoff</td>
1930 <td>turn playback caching off for streaming MNG.</td>
1931 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1932
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1933 <tr>
1934 <td>morphology:compose=<var>compose-method</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1935 <td>Specifies how to merge results generated by multiple<a href="command-line-options.html#morphology">-morphology</a> kernel. The default is none. One
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1936 typical value is 'lighten' as used, for example, with the sobel edge
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1937 kernels. </td>
1938 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1939
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1940 <tr>
1941 <td>morphology:showkernel=<var>1</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1942 <td>Outputs (to 'standard error') all the information about a generated <a href="command-line-options.html#morphology">-morphology</a> kernel.</td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1943 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1944
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1945 <tr>
1946 <td>pcl:fit-to-page=<var>true</var></td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1947
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1948 </tr><tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1949 <td>pdf:fit-page=<var>geometry</var></td>
1950 <td> geometry specifies the scaling dimensions for resizing when the PDF is
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1951 being read. The geometry is either WxH{%} or page size. No offsets are
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1952 allowed. (introduced in IM 6.8.8-8)</td>
1953 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1954
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1955 <tr>
1956 <td>pdf:fit-to-page=<var>true</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1957 <td>&amp;nbsp</td>
1958 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1959
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1960 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1961 <td>pdf:use-cropbox=<var>true</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1962 <td>&amp;nbsp</td>
1963 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1964
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1965 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1966 <td>pdf:use-trimbox=<var>true</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1967 <td>&amp;nbsp</td>
1968 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1969
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1970 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1971 <td>png:bit-depth=<var>value</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]1972 <td>&amp;nbsp</td>
1973 </tr>
1974 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1975 <td>png:color-type=<var>value</var></td>
1976 <td>desired bit-depth and color-type for PNG output. You can force the PNG
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1977 encoder to use a different bit-depth and color-type than it would have
1978 normally selected, but only if this does not cause any loss of image
1979 quality. Any attempt to reduce image quality is treated as an error and no
1980 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1981 can use these "defines" to cause it to be written as an 8-bit grayscale,
1982 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1983 you cannot force it to be written as a grayscale or indexed PNG. If you
1984 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
1985 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
1986 reduce the image quality prior to using the PNG encoder. Note that in
1987 indexed PNG files, "bit-depth" refers to the number of bits per index,
1988 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1989 8-bit depth.</td>
1990 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1991
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1992 <tr>
1993 <td>png:compression-filter=<var>value</var></td>
1994 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]1995 5 means adaptive filtering except for images with a colormap, 6 means
1996 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
1997 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1998 filtering.</td>
1999 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2000
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2001 <tr>
2002 <td>png:compression-level=<var>value</var></td>
2003 <td> valid values are 0 through 9, with 0 providing the least but fastest
2004 compression and 9 usually providing the best and always the slowest.</td>
2005 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2006
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2007 <tr>
2008 <td>png:compression-strategy=<var>value</var></td>
2009 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2010 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2011 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2012 values 3 and 4, respectively, will use the zlib default strategy
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2013 instead.</td>
2014 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2015
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2016 <tr>
2017 <td>png:format=<var>value</var></td>
2018 <td> valid values are <var>png8</var>, <var>png24</var>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2019 <var>png32</var>, <var>png48</var>,
2020 <var>png64</var>, and <var>png00</var>.
2021 This property can be useful for specifying
2022 the specific PNG format to be used, when the usual method of prepending the
2023 format name to the output filename is inconvenient, such as when writing
2024 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2025 Value = <var>png8</var> reduces the number of colors to 256,
2026 only one of which may be fully transparent, if necessary. The other
2027 values do not force any reduction of quality; it is an error to request
2028 a format that cannot represent the image data without loss (except that
2029 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2030 Value = <var>png24</var> and <var>png48</var>
2031 allow transparency, only if a single color is fully transparent and that
2032 color does not also appear in an opaque pixel; such transparency is
2033 written in a PNG <code>tRNS</code> chunk.
2034 Value = <var>png00</var> causes the image to inherit its
2035 color-type and bit-depth from the input image, if the input was also
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2036 a PNG.</td>
2037 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2038
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2039 <tr>
2040 <td>png:exclude-chunk=<var>value</var></td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2041
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2042 </tr><tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2043 <td>png:include-chunk=<var>value</var></td>
2044 <td>ancillary chunks to be excluded from or included in PNG output.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2045
2046 <p>The <var>value</var> can be the name of a PNG chunk-type such
2047 as <var>bKGD</var>, a comma-separated list of chunk-names
2048 (which can include the word <var>date</var>, the word
2049 <var>all</var>, or the word <var>none</var>).
2050 Although PNG chunk-names are case-dependent, you can use all lowercase
2051 names if you prefer.</p>
2052
2053 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2054 of the PNG encoder and have no effect on the PNG decoder.</p>
2055
2056 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2057 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2058 only be written if gamma is not 1/2.2, since most decoders assume
2059 sRGB and gamma=1/2.2 when no colorspace information is included in
2060 the PNG file. Because the list is processed from left to right, you
2061 can achieve this with a single define:</p>
2062
2063<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2064-define png:include-chunk=none,gAMA
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2065</pre>
2066
2067 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2068 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2069 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2070 entire ICC profile. To force the PNG encoder to write the sRGB
2071 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2072 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2073
2074 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2075 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2076 entries appearing in the list will be ignored.</p>
2077
2078 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2079 image has transparency, the PNG colortype is forced to be 4 or 6
2080 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2081 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2082 on the PNG colortype of the output image.</p>
2083
2084 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2085 following for PNG output:</p>
2086
2087<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2088-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2089</pre>
2090
2091 <p>The default behavior is to include all known PNG ancillary chunks
2092 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2093 and to exclude all PNG chunks that are unknown to ImageMagick,
2094 regardless of their PNG "copy-safe" status as described in the
2095 PNG specification.</p>
2096
2097 <p>Any chunk names that are not known to ImageMagick are ignored
2098 if they appear in either the "include-chunk" or "exclude-chunk" list.
2099 The ancillary chunks currently known to ImageMagick are
2100 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2101 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2102 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2103
2104 <p>You can also put <code>date</code> in the list to include or exclude
2105 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2106 inserts in the output PNG.</p></td>
2107 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2108
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2109 <tr>
2110 <td>png:preserve-colormap[=<var>true</var>]</td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2111 <td>Use the existing image-&gt;colormap. Normally the PNG encoder will
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2112 try to optimize the palette, eliminating unused entries and putting
2113 the transparent colors first. If this flag is set, that behavior
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2114 is suppressed.</td>
2115 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2116
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2117 <tr>
2118 <td>png:preserve-iCCP[=<var>true</var>]</td>
2119 <td>By default, the PNG decoder and encoder examine any ICC profile
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2120 that is present, either from an <code>iCCP</code> chunk in the PNG
2121 input or supplied via an option, and if the profile is recognized
2122 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2123 You can use <code>-define png:preserve-iCCP</code> to prevent
2124 this from happening; in such cases the <code>iCCP</code> chunk
2125 will be read or written and no <code>sRGB</code> chunk will be
2126 written. There are some ICC profiles that claim to be sRGB but
2127 have various errors that cause them to be rejected by libpng16; such
2128 profiles are recognized anyhow and converted to the <code>sRGB</code>
2129 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2130 is present. Note that not all "sRGB" ICC profiles are recognized
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2131 yet; we will add them to the list as we encounter them.</td>
2132 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2133
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2134 <tr>
2135 <td>png:swap-bytes[=<var>true</var>]</td>
2136 <td>The PNG specification requires that any multi-byte integers be stored in
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2137 network byte order (MSB-LSB endian). This option allows you to
2138 fix any invalid PNG files that have 16-bit samples stored incorrectly
2139 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2140 must appear before the input filename on the commandline. The swapping
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2141 is done during the libpng decoding operation.</td>
2142 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2143
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2144 <tr>
2145 <td>profile:skip=<var>name1,name2,...</var></td>
2146 <td>Skip the named profile[s] when reading the image. Use skip="*" to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2147 skip all named profiles in the image. Many named profiles exist,
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2148 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2149 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2150
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2151 <tr>
2152 <td>ps:imagemask</td>
2153 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2154 Postscript files that render bilevel images with the Postscript imagemask
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2155 operator instead of the image operator.</td>
2156 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2157
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2158 <tr>
2159 <td>quantum:format=<var>type</var></td>
2160 <td>Set the type to <code>floating-point</code> to specify a floating-point
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2161 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2162 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2163 included, the result is a single precision floating point format.
2164 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2165 double precision floating point format.</td>
2166 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2167
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2168 <tr>
2169 <td>quantum:polarity=<var>photometric-interpretation</var></td>
2170 <td>Set the photometric-interpretation of an image (typically for TIFF image
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2171 file format) to either <code>min-is-black</code> (default) or
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2172 <code>min-is-white</code>.</td>
2173 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2174
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2175 <tr>
2176 <td>sample:offset=<var>geometry</var></td>
2177 <td>Location of the sampling point within the sub-region being sampled,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2178 expressed as percentages (see <a href="command-line-options.html#sample">-sample</a>).</td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2179 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2180
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2181 <tr>
2182 <td>showkernel=<var>1</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2183 <td>Outputs (to 'standard error') all the information about a generated <a href="command-line-options.html#morphology">-morphology</a> kernel.</td>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2184 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2185
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2186 <tr>
2187 <td>stream:buffer-size=<var>value</var></td>
2188 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2189 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2190
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2191 <tr>
2192 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
2193 <td>Specify the alpha extra samples as associated, unassociated or unspecified </td>
2194 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2195
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2196 <tr>
2197 <td>tiff:endian=<var>msb|lsb</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2198 <td>&amp;nbsp</td>
2199 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2200
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2201 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2202 <td>tiff:exif-properties=<var>false</var></td>
2203 <td>Skips reading the EXIF properties.</td>
2204 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2205
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2206 <tr>
2207 <td>tiff:fill-order=<var>msb|lsb</var></td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2208 <td>&amp;nbsp</td>
2209 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2210
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2211 <tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2212 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2213 <td>Allows one or more tag ID values to be ignored.</td>
2214 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2215
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2216 <tr>
2217 <td>tiff:rows-per-strip=<var>value</var></td>
2218 <td>Sets the number of rows per strip</td>
2219 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2220
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2221 <tr>
2222 <td>tiff:tile-geometry=<var>WxH</var></td>
2223 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2224 PTIF: before the outputname</td>
2225 </tr>
2226</table>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2227
2228<p>For example, to create a postscript file that will render only the black
2229pixels of a bilevel image, use:</p>
2230
2231<pre>
2232convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2233</pre>
2234
2235<p>Set attributes of the image registry by prefixing the value with
2236<code>registry:</code>. For example, to set a temporary path to put work files,
2237use:</p>
2238
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2239<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2240-define registry:temporary-path=/data/tmp
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2241</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2242
2243<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2244 <h3 class="magick-header"><a id="delay"></a>-delay <var>ticks</var> <br>-delay <var>ticks</var>x<var>ticks-per-second</var> {<var>&lt;</var>} {<var>&gt;</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2245</div>
2246
2247<p class="magick-description">display the next image after pausing.</p>
2248
2249<p>This option is useful for regulating the animation of image sequences
2250<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2251next image. The default is no delay between each showing of the image
2252sequence. The default ticks-per-second is 100.</p>
2253
2254<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2255value exceeds the given delay. <code>&lt;</code> changes the image delay
2256<var>only</var> if current value is less than the given delay. For example, if
2257you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2258not change. However, if the image delay is 40 or 50, the delay it is changed
2259to 30. Enclose the given delay in quotation marks to prevent the
2260<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2261a file redirection.</p>
2262
2263
2264<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2265 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2266</div>
2267
2268<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2269
2270<p>Specify the image by its index in the sequence. The first image is index
22710. Negative indexes are relative to the end of the sequence, for example, -1
2272represents the last image of the sequence. Specify a range of images with
2273a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
2274<code>+delete</code> to delete the last image in the current image sequence.</p>
2275
2276
2277<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2278 <h3 class="magick-header"><a id="density"></a>-density <var>width</var><br>-density <var>width</var>x<var>height</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2279</div>
2280
2281<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2282
2283<p>This option specifies the image resolution to store while encoding a raster
2284image or the canvas resolution while rendering (reading) vector formats such
2285as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2286provides the unit of measure to apply when rendering to an output device or
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2287raster image. The default unit of measure is in dots per inch (DPI). The <a href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2288instead.</p>
2289
2290<p>The default resolution is 72 dots per inch, which is equivalent to one
2291point per pixel (Macintosh and Postscript standard). Computer screens are
2292normally 72 or 96 dots per inch, while printers typically support 150, 300,
2293600, or 1200 dots per inch. To determine the resolution of your display, use
2294a ruler to measure the width of your screen in inches, and divide by the
2295number of horizontal pixels (1024 on a 1024x768 display).</p>
2296
2297<p>If the file format supports it, this option may be used to update the
2298stored image resolution. Note that Photoshop stores and obtains image
2299resolution from a proprietary embedded profile. If this profile is not
2300stripped from the image, then Photoshop will continue to treat the image using
2301its former resolution, ignoring the image resolution specified in the standard
2302file header.</p>
2303
2304<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2305does not alter the underlying raster image. It may be used to adjust the
2306rendered size for desktop publishing purposes by adjusting the scale applied
2307to the pixels. To resize the image so that it is the same size at a different
2308resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2309
2310<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2311 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2312</div>
2313
2314<p class="magick-description">depth of the image.</p>
2315
2316<p>This the number of bits in a color sample within a pixel. Use this option
2317to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2318or CMYK, or to change the depth of any image after it has been read.</p>
2319
2320<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2321 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2322</div>
2323
2324<p class="magick-description">obtain image by descending window hierarchy.</p>
2325
2326<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2327 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2328</div>
2329
2330<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2331
2332<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
2333<var>width</var></code> to auto crop the image. The set argument is the pixel
2334width of the image background (e.g 40).</p>
2335
2336<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2337 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2338</div>
2339
2340<p class="magick-description">reduce the speckles within an image.</p>
2341
2342<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2343 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2344</div>
2345
2346<p class="magick-description">render text right-to-left or left-to-right.</p>
2347
2348<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2349 <h3 class="magick-header"><a id="displace"></a>-displace <var>horizontal-scale</var><br>-displace <var>horizontal-scale</var>x<var>vertical-scale</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2350</div>
2351
2352<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2353
2354<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2355is used as a displacement map, which is used to displace the lookup of
2356what part of the 'background' image is seen at each point of the overlaid
2357area. Much like the displacement map is a 'lens' that redirects light shining
2358through it so as to present a distorted view the original 'background' image
2359behind it. </p>
2360
2361<p>Any perfect grey areas of the displacement map produce a zero
2362displacement of the image. Black areas produce the given maximum negative
2363displacement of the lookup point, while white produce a maximum positive
2364displacement of the lookup. </p>
2365
2366<p>Note that it is the lookup of the 'background' that is displaced, not a
2367displacement of the image itself. As such an area of the displacement map
2368containing 'white' will have the lookup point 'shifted' by a positive amount,
2369and thus generating a copy of the destination image to the right/downward from
2370the correct position. That is the image will look like it may have been
2371'shifted' in a negative left/upward direction. Understanding this is a very
2372important in understanding how displacement maps work. </p>
2373
2374<p>The given arguments define the maximum amount of displacement in pixels
2375that a particular map can produce. If the displacement scale is large enough
2376it is also possible to lookup parts of the 'background' image that lie well
2377outside the bounds of the displacement map itself. That is you could very
2378easily copy a section of the original image from outside the overlay area
2379into the overlay area. </p>
2380
2381<p>The '%' flag makes the displacement scale relative to the size of the
2382overlay image (100% = half width/height of image). Using '!' switches
2383percentage arguments to refer to the destination image size instead.
2384these flags were added as of IM v6.5.3-5.</p>
2385
2386<p>Normally a single grayscale displacement map is provided, which with the
2387given scaling values will determine a single direction (vector) in which
2388displacements can occur (positively or negatively). However, if you also
2389specify a third image which is normally used as a <var>mask</var>,
2390the <var>composite image</var> is used for horizontal X
2391displacement, while the <var>mask image</var> is used for vertical Y
2392displacement. This allows you to define completely different displacement
2393values for the X and Y directions, and allowing you to lookup any point within
2394the <var>scale</var> bounds. In other words each pixel can lookup
2395any other nearby pixel, producing complex 2 dimensional displacements, rather
2396than a simple 1 dimensional vector displacements. </p>
2397
2398<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2399you can use the 'red' channel of the overlay image to specify the horizontal
2400or X displacement, and the 'green' channel for the vertical or Y displacement.
2401</p>
2402
2403<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2404mask the transparency of the destination image. However areas outside the
2405overlaid areas will not be effected. </p>
2406
2407
2408<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2409 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2410</div>
2411
2412<p class="magick-description">Specifies the X server to contact.</p>
2413
2414<p>This option is used with convert for obtaining image or font from this
2415X server. See <var>X(1)</var>.</p>
2416
2417<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2418 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2419</div>
2420
2421<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2422
2423<p>The layer disposal method defines the way each the displayed image is to be
2424modified after the current 'frame' of an animation has finished being
2425displayed (after its 'delay' period), but before the next frame on an
2426animation is to be overlaid onto the display. </p>
2427
2428<p>Here are the valid methods:</p>
2429
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2430<dl class="dl-horizontal">
2431<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2432<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2433<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2434<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2435</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2436
2437<p>You can also use the numbers given above, which is what the GIF format
2438uses internally to represent the above settings. </p>
2439
2440<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2441
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2442<p>Use <a href="command-line-options.html#dispose">+dispose</a>, turn off the setting and prevent
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2443resetting the layer disposal methods of images being read in. </p>
2444
2445<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2446disposal method for images already in memory.</p>
2447
2448<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2449 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2450</div>
2451
2452<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2453
2454
2455<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2456 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2457</div>
2458
2459<p class="magick-description">dissolve an image into another by the given percent.</p>
2460
2461<p>The opacity of the composite image is multiplied by the given percent, then
2462it is composited 'over' the main image. If <var>src_percent</var>
2463is greater than 100, start dissolving the main image so it becomes
2464transparent at a value of '<code>200</code>'. If both percentages
2465are given, each image are dissolved to the percentages given. </p>
2466
2467<p>Note that dissolve percentages do not add, two opaque images dissolved
2468'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2469images, you would need to use dissolve values of '50,100'. </p>
2470
2471<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2472 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2473</div>
2474
2475<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2476
2477<p>The <var>arguments</var> is a single string containing a list
2478of floating point numbers separated by commas or spaces. The number of
2479and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2480
2481<p>Choose from these distortion types:</p>
2482
2483<table class="table table-condensed table-striped">
2484 <tr>
2485 <th style="width: 8%">Method</th>
2486 <th>Description</th>
2487 </tr>
2488
2489 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2490 <td>ScaleRotateTranslate <br> SRT</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2491 <td>
2492 Distort image by first scaling and rotating about a given 'center',
2493 before translating that 'center' to the new location, in that order. It
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2494 is an alternative method of specifying a 'Affine' type of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2495 distortion, but without shearing effects. It also provides a good way
2496 of rotating and displacing a smaller image for tiling onto a larger
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2497 background (IE 2-dimensional animations). <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2498
2499 The number of arguments determine the specific meaning of each
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2500 argument for the scales, rotation, and translation operations. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2501
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2502 <dl class="dl-horizontal">
2503 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2504 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2505 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2506 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2507 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2508 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2509 </dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2510
2511 This is actually an alternative way of specifying a 2 dimensional linear
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2512 'Affine' or 'AffineProjection' distortion. </td> </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2513
2514 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2515 <td>Affine</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2516 <td>
2517 Distort the image linearly by moving a list of at least 3 or more sets
2518 of control points (as defined below). Ideally 3 sets or 12 floating
2519 point values are given allowing the image to be linearly scaled,
2520 rotated, sheared, and translated, according to those three points. See
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2521 also the related 'AffineProjection' and 'SRT'
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2522 distortions. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2523
2524 More than 3 sets given control point pairs (12 numbers) is least
2525 squares fitted to best match a linear affine distortion. If only 2
2526 control point pairs (8 numbers) are given a two point image translation
2527 rotation and scaling is performed, without any possible shearing,
2528 flipping or changes in aspect ratio to the resulting image. If only one
2529 control point pair is provides the image is only translated, (which may
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2530 be a floating point non-integer translation). <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2531
2532 This distortion does not include any form of perspective distortion.
2533 </td>
2534
2535 </tr>
2536
2537 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2538 <td>AffineProjection</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2539 <td>
2540 Linearly distort an image using the given Affine Matrix of 6
2541 pre-calculated coefficients forming a set of Affine Equations to map
2542 the source image to the destination image.
2543
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2544 <p class="text-center"><var>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2545 s<sub>x</sub>, r<sub>x</sub>,
2546 r<sub>y</sub>, s<sub>y</sub>,
2547 t<sub>x</sub>, t<sub>y</sub>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2548 </var></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2549
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2550 See <a href="command-line-options.html#affine">-affine</a> setting for more detail, and
2551 meanings of these coefficients. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2552
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2553 The distortions 'Affine' and 'SRT' provide
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2554 alternative methods of defining this distortion, with ImageMagick doing
2555 the calculations needed to generate the required coefficients. You can
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2556 see the internally generated coefficients, by using a <a href="command-line-options.html#verbose">-verbose</a> setting with those other variants. </td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2557
2558 </tr>
2559
2560 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2561 <td>BilinearForward<br>
2562 BilinearReverse</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2563 <td>
2564 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2565 16 values (see below). Not that lines may not appear straight after
2566 distortion, though the distance between coordinates will remain
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2567 consistent. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2568
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2569 The 'BilinearForward' is used to map rectangles to any
2570 quadrilateral, while the 'BilinearReverse' form maps any
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2571 quadrilateral to a rectangle, while preserving the straight line edges
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2572 in each case. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2573
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2574 Note that 'BilinearForward' can generate invalid pixels
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2575 which will be colored using the <a href="command-line-options.html#mattecolor">-mattecolor</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2576 color setting. Also if the quadrilateral becomes 'flipped' the image
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2577 may disappear. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2578
2579 There are future plans to produce a true Bilinear distortion that will
2580 attempt to map any quadrilateral to any other quadrilateral, while
2581 preserving edges (and edge distance ratios).
2582
2583 </td>
2584 </tr>
2585
2586 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2587 <td>Perspective</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2588 <td>
2589 Perspective distort the images, using a list of 4 or more sets of
2590 control points (as defined below). More that 4 sets (16 numbers) of
2591 control points provide least squares fitting for more accurate
2592 distortions (for the purposes of image registration and panorama
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2593 effects). Less than 4 sets will fall back to a 'Affine'
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2594 linear distortion. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2595
2596 Perspective Distorted images ensures that straight lines remain
2597 straight, but the scale of the distorted image will vary. The horizon
2598 is anti-aliased, and the 'sky' color may be set using the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2599 <a href="command-line-options.html#mattecolor">-mattecolor</a> setting. </td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2600 </tr>
2601
2602 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2603 <td>PerspectiveProjection </td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2604 <td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2605 Do a 'Perspective' distortion biased on a set of 8
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2606 pre-calculated coefficients. You can get these coefficients by looking
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2607 at the <a href="command-line-options.html#verbose">-verbose</a> output of a
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2608 'Perspective' distortion, or by calculating them yourself.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2609 If the last two perspective scaling coefficients are zero, the
2610 remaining 6 represents a transposed 'Affine Matrix'. </td>
2611
2612 </tr>
2613
2614 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2615 <td>Arc</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2616 <td>
2617 Arc the image (variation of polar mapping) over the angle given around
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2618 a circle.
2619
2620 <p></p><dl class="dl-horizontal">
2621 <dt>arc_angle</dt>
2622 <dd>The angle over which to arc the image side-to-side</dd>
2623 <dt>rotate_angle</dt>
2624 <dd>Angle to rotate resulting image from vertical center</dd>
2625 <dt>top_radius</dt>
2626 <dd>Set top edge of source image at this radius</dd>
2627 <dt>bottom_radius </dt>
2628 <dd>Set bottom edge to this radius (radial scaling)</dd>
2629 </dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2630
2631 The resulting image is always resized to best fit the resulting image,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2632 (as if using <a href="command-line-options.html#distort">+distort</a>) while attempting to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2633 preserve scale and aspect ratio of the original image as much as
2634 possible with the arguments given by the user. All four arguments will
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2635 be needed to change the overall aspect ratio of an 'Arc'ed image. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2636
2637 This a variation of a polar distortion designed to try to preserve the
2638 aspect ratio of the image rather than direct Cartesian to Polar
2639 conversion. </td>
2640 </tr>
2641
2642 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2643 <td>Polar</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2644 <td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2645 Like 'Arc' but do a complete Cartesian to Polar mapping of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2646 the image. that is the height of the input image is mapped to the
2647 radius limits, while the width is wrapped around between the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2648 angle limits. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2649
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2650 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2651
2652 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2653 center to the center of the image, and the angles going from -180 (top)
2654 to +180 (top). If <var>Rmax</var> is given the special value of
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2655 '0', the the distance from the center to the nearest edge
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2656 is used for the radius of the output image, which will ensure the whole
2657 image is visible (though scaled smaller). However a special value of
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2658 '-1' will use the distance from the center to the furthest
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2659 corner, This may 'clip' the corners from the input rectangular image,
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2660 but will generate the exact reverse of a 'DePolar' with
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2661 the same arguments. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2662
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2663 If the plus form of distort (<a href="command-line-options.html#distort">+distort</a>) is used
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2664 output image center will default to 0,0 of the virtual
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2665 canvas, and the image size adjusted to ensure the whole input image is
2666 made visible in the output image on the virtual canvas. </td>
2667
2668 </tr>
2669
2670 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2671 <td>DePolar</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2672 <td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2673 Uses the same arguments and meanings as a 'Polar' distortion
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2674 but generates the reverse Polar to Cartesian distortion. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2675
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2676 The special <var>Rmax</var> setting of '0' may however clip
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2677 the corners of the input image. However using the special
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2678 <var>Rmax</var> setting of '-1' (maximum center to corner
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2679 distance) will ensure the whole distorted image is preserved in the
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2680 generated result, so that the same argument to 'Polar' will
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2681 reverse the distortion re-producing the original.
2682
2683 Note that as this distortion requires the area resampling of a circular
2684 arc, which can not be handled by the builtin EWA resampling function.
2685 As such the normal EWA filters are turned off. It is recommended some
2686 form of 'super-sampling' image processing technique be used to produce
2687 a high quality result. </td>
2688
2689 </tr>
2690
2691 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2692 <td>Barrel</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2693 <td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2694 Given the four coefficients (A,B,C,D) as defined by <a href="http://wiki.panotools.org/Lens_correction_model">Helmut
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2695 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2696 correct radial lens distortions. That is in photographs, make straight
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2697 lines straight again. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2698
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2699 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2700 <var>X</var> , <var>Y</var> ] ] <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2701 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2702 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2703 [ <var>X</var> , <var>Y</var> ] </p>
2704 So that it forms the function
2705 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2706 <var>C</var>*r + <var>D</var> )</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2707
2708 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2709 (defaulting to the center of the image). <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2710 The second form is typically used to distort images, rather than
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2711 correct lens distortions. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2712 </td>
2713
2714 </tr>
2715
2716 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2717 <td>BarrelInverse</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2718 <td>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2719 This is very similar to 'Barrel' with the same set of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2720 arguments, and argument handling. However it uses the inverse
2721 of the radial polynomial,
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2722 so that it forms the function
2723 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2724 <var>C</var>*r + <var>D</var> )</p>
2725 Note that this is not the reverse of the 'Barrel'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2726 distortion, just a different barrel-like radial distortion method.
2727
2728 </td>
2729 </tr>
2730
2731 <tr>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2732 <td>Shepards</td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2733 <td>
2734 Distort the given list control points (any number) using an Inverse
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2735 Squared Distance Interpolation Method (<a href="http://en.wikipedia.org/wiki/Shepard%27s_method">Shepards
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2736 Method</a>). The control points in effect do 'localized' displacement
2737 of the image around the given control point (preserving the look and
2738 the rotation of the area near the control points. For best results
2739 extra control points should be added to 'lock' the positions of the
2740 corners, edges and other unchanging parts of the image, to prevent
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2741 their movement. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2742
2743 The distortion has been likened to 'taffy pulling' using nails, or
2744 pins' stuck in a block of 'jelly' which is then moved to the new
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2745 position, distorting the surface of the jelly. <br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2746
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2747 Internally it is equivalent to generating a displacement map (see <a href="command-line-options.html#displace">-displace</a>) for source image color look-up using
2748 the <a href="command-line-options.html#sparse-color">-sparse-color</a> method of the same name.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2749
2750 </td>
2751 </tr>
2752
2753</table>
2754
2755<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2756distort</a>.</p>
2757
2758<p>Many of the above distortion methods such as '<code>Affine</code>',
2759'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
2760defining how these points in the given image should be distorted in the
2761destination image. Each set of four floating point values represent a source
2762image coordinate, followed immediately by the destination image coordinate.
2763This produces a list of values such as...</p>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2764<p class="text-center"><var>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2765 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
2766 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
2767 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
2768 ...
2769 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2770</var></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2771<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
2772destination image. </p>
2773
2774<p>For example, to warp an image using '<code>perspective</code>' distortion,
2775needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2776perspective distortion of the built-in "rose:" image. Note how spaces were
2777used to group the 4 sets of coordinate pairs, to make it easier to read and
2778understand.</p>
2779
2780<pre>
2781convert rose: -virtual-pixel black \
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2782 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
2783 rose_3d_rotated.gif"
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2784</pre>
2785
2786<p>If more that the required number of coordinate pairs are given for
2787a distortion, the distortion method is 'least squares' fitted to produce the
2788best result for all the coordinate pairs given. If less than the ideal number
2789of points are given, the distort will generally fall back to a simpler form of
2790distortion that can handles the smaller number of coordinates (usually a linear
2791'<code>Affine</code>' distortion). </p>
2792
2793<p>By using more coordinates you can make use of image registration tool to
2794find matching coordinate pairs in overlapping images, so as to improve the
2795'fit' of the distortion. Of course a bad coordinate pair can also make the
2796'fit' worse. Caution is always advised. </p>
2797
2798<p>Colors are acquired from the source image according to a cylindrical
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2799resampling <a href="command-line-options.html#filter">-filter</a>, using a special technique known as
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2800EWA resampling. This produces very high quality results, especially when
2801images become smaller (minified) in the output, which is very common when
2802using '<code>perspective</code>' distortion. For example here we view
2803a infinitely tiled 'plane' all the way to the horizon. </p>
2804
2805<pre>
2806convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2807 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
2808 checks_tiled.jpg
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2809</pre>
2810
2811<p>Note that a infinitely tiled perspective images involving the horizon can
2812be very slow, because of the number of pixels that are compressed to generate
2813each individual pixel close to the 'horizon'. You can turn off EWA
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2814resampling, by specifing the special <a href="command-line-options.html#filter">-filter</a> setting of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2815'<code>point</code>' (recommended if you plan to use super-sampling instead).
2816</p>
2817
2818<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2819example, <a href="command-line-options.html#distort">-distort</a> will use the current <a href="command-line-options.html#mattecolor">-mattecolor</a> setting for these pixels. If you do not
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2820what these pixels to be visible, set the color to match the rest of the
2821ground. </p>
2822
2823<p>The output image size will by default be the same as the input image. This
2824means that if the part of the distorted image falls outside the viewed area of
2825the 'distorted space', those parts is clipped and lost. However if you use
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2826the plus form of the operator (<a href="command-line-options.html#distort">+distort</a>) the operator
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2827will attempt (if possible) to show the whole of the distorted image, while
2828retaining a correct 'virtual canvas' offset, for image layering. This offset
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2829may need to be removed using <a href="command-line-options.html#repage">+repage</a>, to remove if it
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2830is unwanted. </p>
2831
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2832<p>Setting <a href="command-line-options.html#verbose">-verbose</a> setting, will cause <a href="command-line-options.html#distort">-distort</a> to attempt to output the internal coefficients,
2833and the <a href="command-line-options.html#fx">-fx</a> equivalent to the distortion, for expert study,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2834and debugging purposes. This many not be available for all distorts. </p>
2835
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2836<p>You can alternatively specify a special "<code><a href="command-line-options.html#define">-define</a> distort:viewport={geometry_string}</code>" setting which will
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2837specify the size and the offset of the generated 'viewport' image of the
2838distorted image space.</p>
2839
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2840<p>Setting a "<code><a href="command-line-options.html#define">-define</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2841distort:scale={scale_factor}</code>" will scale the output image (viewport or
2842otherwise) by that factor without changing the viewed contents of the
2843distorted image. This can be used either for 'super-sampling' the image for
2844a higher quality result, or for panning and zooming around the image (with
2845appropriate viewport changes, or post-distort cropping and resizing). </p>
2846
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2847<p>Setting "<code><a href="command-line-options.html#define">-define</a> resample:verbose=1</code>"
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2848will output the cylindrical filter lookup table created by the EWA (Elliptical
2849Weighted Average) resampling algorithm. Note this table uses a squared radius
2850lookup value. This is typically only used for debugging EWA resampling. </p>
2851
2852
2853<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2854 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2855</div>
2856
2857<p class="magick-description">launch a distributed pixel cache server. </p>
2858
2859<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2860 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2861</div>
2862
2863<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
2864images when general color reduction is applied via an option, or automagically
2865when saving to specific formats. This enabled by default.</p>
2866
2867<p>Dithering places two or more colors in neighboring pixels so that to the
2868eye a closer approximation of the images original color is reproduced. This
2869reduces the number of colors needed to reproduce the image but at the cost of
2870a lower level pattern of colors. Error diffusion dithers can use any set of
2871colors (generated or user defined) to an image. </p>
2872
2873<p>Dithering is turned on by default, to turn it off use the plus form of the
2874setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
2875without text or graphic aliasing. Disabling dithering often (but not always)
2876leads to faster process, a smaller number of colors, but more cartoon like
2877image coloring. Generally resulting in 'color banding' effects in areas with
2878color gradients. </p>
2879
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2880<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap%20">-remap</a>, and <a href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2881color set they created. These operators are also used as part of automatic
2882color reduction when saving images to formats with limited color support, such
2883as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
2884in these cases. </p>
2885
2886<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2887to generate purely random dither. Or use <a href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2888patterns, using uniform color maps, rather than specific color maps. </p>
2889
2890
2891<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2892 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2893</div>
2894
2895<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
2896
2897<p>Use this option to annotate or decorate an image with one or more graphic
2898primitives. The primitives include shapes, text, transformations, and pixel
2899operations.</p>
2900
2901<p>The shape primitives:</p>
2902
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2903<dl class="dl-horizontal">
2904<dt>point</dt><dd> x,y</dd>
2905<dt>line</dt><dd> x0,y0 x1,y1</dd>
2906<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
2907<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
2908<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
2909<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
2910<dt>circle</dt><dd> x0,y0 x1,y1</dd>
2911<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
2912<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
2913<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
2914<dt>path</dt><dd>specification </dd>
2915<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
2916</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2917
2918<p>The text primitive:</p>
2919
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2920<dl class="dl-horizontal">
2921<dt>text</dt><dd>x0,y0 string</dd>
2922</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2923<p>The text gravity primitive:</p>
2924
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2925<dl class="dl-horizontal">
2926<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
2927</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2928
2929<p>The text gravity primitive only affects the placement of text and does not
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2930interact with the other primitives. It is equivalent to using the <a href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2931scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
2932
2933<p>The transformation primitives:</p>
2934
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2935<dl class="dl-horizontal">
2936<dt>rotate</dt><dd>degrees</dd>
2937<dt>translate</dt><dd>dx,dy</dd>
2938<dt>scale</dt><dd>sx,sy</dd>
2939<dt>skewX</dt><dd>degrees</dd>
2940<dt>skewY</dt><dd>degrees</dd>
2941</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2942
2943<p>The pixel operation primitives:</p>
2944
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]2945<dl class="dl-horizontal">
2946<dt>color</dt><dd>x0,y0 method</dd>
2947<dt>matte</dt><dd>x0,y0 method</dd>
2948</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2949
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2950<p>The shape primitives are drawn in the color specified by the preceding <a href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
2951"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2952
2953<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
2954pixel plane, that is, by an ordered pair of integer coordinates,
2955<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2956primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2957
2958<p>A <code>line</code> primitive requires a start point and end point.</p>
2959
2960<p>A <code>rectangle</code> primitive is specified by the pair of points at the
2961upper left and lower right corners.</p>
2962
2963<p>A <code>roundRectangle</code> primitive takes the same corner points as
2964a <code>rectangle</code> followed by the width and height of the rounded corners
2965to be removed.</p>
2966
2967<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
2968Give the center and any point on the perimeter (boundary).</p>
2969
2970<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
2971to a given rectangle. An <code>arc</code> requires the two corners used for
2972<code>rectangle</code> (see above) followed by the start and end angles of the
2973arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
2974points produced are then joined with a line segment and the resulting segment
2975of an ellipse is filled.</p>
2976
2977<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
2978center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
2979the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
29800,360).</p>
2981
2982<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
2983more points to define their perimeters. A <code>polyline</code> is simply
2984a <code>polygon</code> in which the final point is not stroked to the start
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]2985point. When unfilled, this is a <var>polygonal line</var>. If the <a href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2986a <code>polyline</code> is identical to a <code>polygon</code>. </p>
2987
2988<p>A <var>coordinate</var> is a pair of integers separated by a space or
2989optional comma. </p>
2990
2991<p>As an example, to define a circle centered at 100,100 that extends to
2992150,150 use:</p>
2993
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]2994<pre>
2995-draw 'circle 100,100 150,150'
2996</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2997
2998<p>The <code>Bezier</code> primitive creates a spline curve and requires three
2999or points to define its shape. The first and last points are the
3000<var>knots</var> and these points are attained by the curve, while any
3001intermediate coordinates are <var>control points</var>. If two control points
3002are specified, the line between each end knot and its sequentially respective
3003control point determines the tangent direction of the curve at that end. If
3004one control point is specified, the lines from the end knots to the one
3005control point determines the tangent directions of the curve at each end. If
3006more than two control points are specified, then the additional control points
3007act in combination to determine the intermediate shape of the curve. In order
3008to draw complex curves, it is highly recommended either to use the
3009<code>path</code> primitive or to draw multiple four-point bezier segments with
3010the start and end knots of each successive segment repeated. For example:</p>
3011
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3012<pre>
3013-draw 'bezier 20,50 45,100 45,0 70,50'
3014-draw 'bezier 70,50 95,100 95,0 120,50'
3015</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3016
3017<p>A <code>path</code> represents an outline of an object, defined in terms of
3018moveto (set a new current point), lineto (draw a straight line), curveto (draw
3019a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3020current shape by drawing a line to the last moveto) elements. Compound paths
3021(i.e., a path with subpaths, each consisting of a single moveto followed by
3022one or more line or curve operations) are possible to allow effects such as
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3023<var>donut holes</var> in objects. (See <a href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3024
3025<p>Use <code>image</code> to composite an image with another image. Follow the
3026image keyword with the composite operator, image location, image size, and
3027filename:</p>
3028
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3029<pre>
3030-draw 'image SrcOver 100,100 225,225 image.jpg'
3031</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3032
3033<p>You can use 0,0 for the image size, which means to use the actual
3034dimensions found in the image header. Otherwise, it is scaled to the given
3035dimensions. See <a href="compose.html">Alpha Compositing</a> for
3036a detailed discussion of alpha composition methods that are available. </p>
3037
3038<p>The "special augmented compose operators" such as "dissolve" that require
3039arguments cannot be used at present with the <code>-draw image</code> option.
3040 </p>
3041
3042<p>Use <code>text</code> to annotate an image with text. Follow the text
3043coordinates with a string. If the string has embedded spaces, enclose it in
3044single or double quotes.</p>
3045
3046<p>For example, the following annotates the image with <code>Works like
3047magick!</code> for an image titled <code>bird.miff</code>. </p>
3048
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3049<pre>
3050-draw "text 100,100 'Works like magick!' "
3051</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3052
3053<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3054to annotate an image with text.</p>
3055
3056<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3057text primitives about the origin of the main image. If the <a href="command-line-options.html#region">-region</a> option precedes the <a href="command-line-options.html#draw">-draw</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3058option, the origin for transformations is the upper left corner of the
3059region.</p>
3060
3061<p>The <code>translate</code> primitive translates subsequent shape and text
3062primitives.</p>
3063
3064<p>The <code>scale</code> primitive scales them.</p>
3065
3066<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3067to the origin of the main image or the region.</p>
3068
3069<p>The transformations modify the current affine matrix, which is initialized
3070from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3071option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3072option. The initial affine matrix is not affected; that matrix is only changed
3073by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3074<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3075reinitialized from the initial affine matrix.</p>
3076
3077<p>Use the <code>color</code> primitive to change the color of a pixel to the
3078fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3079a method:</p>
3080
3081<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3082point
3083replace
3084floodfill
3085filltoborder
3086reset
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3087</pre>
3088
3089<p>Consider the target pixel as that specified by your coordinate. The
3090<code>point</code> method recolors the target pixel. The <code>replace</code>
3091method recolors any pixel that matches the color of the target pixel.
3092<code>Floodfill</code> recolors any pixel that matches the color of the target
3093pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3094pixel that is not the border color. Finally, <code>reset</code> recolors all
3095pixels.</p>
3096
3097<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3098Follow the pixel coordinate with a method (see the <code>color</code> primitive
3099for a description of methods). The <code>point</code> method changes the matte
3100value of the target pixel. The <code>replace</code> method changes the matte
3101value of any pixel that matches the color of the target pixel.
3102<code>Floodfill</code> changes the matte value of any pixel that matches the
3103color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3104changes the matte value of any neighbor pixel that is not the border color (<a href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3105matte value of all pixels.</p>
3106
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3107<p>You can set the primitive color, font, and font bounding box color with <a 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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3108respectively. Options are processed in command line order so be sure to use
3109these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3110
3111<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3112than 1.png).</p>
3113
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3114<p>Drawing primitives conform to the <a href="magick-vector-graphics.html">Magick
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3115Vector Graphics</a> format.</p>
3116
3117
3118<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3119 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3120</div>
3121
3122<p class="magick-description">duplicate an image one or more times.</p>
3123
3124<p>Specify the count and the image to duplicate by its index in the sequence.
3125The first image is index 0. Negative indexes are relative to the end of the
3126sequence, for example, -1 represents the last image of the sequence. Specify
3127a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
31280,2). Use <code>+duplicate</code> to duplicate the last image in the current
3129image sequence.</p>
3130
3131<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3132 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3133</div>
3134
3135<p class="magick-description">detect edges within an image.</p>
3136
3137<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3138 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3139</div>
3140
3141<p class="magick-description">emboss an image.</p>
3142
3143<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3144 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3145</div>
3146
3147<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3148
3149<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3150
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]3151<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3152Decipher an Image</a>.</p>
3153
3154
3155
3156<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3157 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3158</div>
3159
3160<p class="magick-description">specify the text encoding.</p>
3161
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]3162<p>Choose from</p>
3163
3164<pre>
3165AdobeCustom AdobeExpert
3166AdobeStandard AppleRoman
3167BIG5 GB2312
3168Latin 2 None
3169SJIScode Symbol
3170Unicode Wansung
3171</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3172
3173<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3174 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3175</div>
3176
3177<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3178
3179<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3180
3181<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3182
3183
3184<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3185 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3186</div>
3187
3188<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3189
3190
3191<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3192 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3193</div>
3194
3195<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3196
3197<p>To perform histogram equalization on all channels in concert, transform the
3198image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3199equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3200
3201<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3202-equalize -colorspace RGB</code> ...</p>
3203
3204<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3205components transformation that puts most of the information in the first
3206channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3207-colorspace RGB</code> ...</p>
3208
3209<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3210 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3211</div>
3212
3213<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3214
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3215<p>(See the <a href="command-line-options.html#function">-function</a> operator for some
3216multi-parameter functions. See the <a href="command-line-options.html#fx">-fx</a> operator if more
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3217elaborate calculations are needed.)</p>
3218
3219<p>The behaviors of each <var>operator</var> are summarized in the
3220following list. For brevity, the numerical value of a "pixel" referred to
3221below is the value of the corresponding channel of that pixel, while
3222a "normalized pixel" is that number divided by the maximum
3223(installation-dependent) value <var>QuantumRange</var>. (If
3224normalized pixels are used, they are restored, following the other
3225calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3226
3227<table class="table table-condensed table-striped">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3228 <col width="25%">
3229 <col width="75%">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3230 <thead>
3231 <tr>
3232 <th><var>operator</var></th>
3233 <th>Summary (see further below for details)</th>
3234 </tr>
3235 </thead>
3236 <tbody>
3237
3238 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3239 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3240 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3241 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3242 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3243 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3244 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3245 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3246 <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>
3247 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]3248 <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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3249 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3250 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]3251 <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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3252 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3253 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3254 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3255 <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>
3256 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3257 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3258 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3259 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3260 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3261 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3262
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]3263 <tr><td> </td><td> </td></tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3264
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3265 <tr><td>Gaussian-noise</td><td> </td></tr>
3266 <tr><td>Impulse-noise</td><td> </td></tr>
3267 <tr><td>Laplacian-noise</td><td> </td></tr>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3268 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="command-line-options.html#noise">-noise</a> operators.)</td></tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3269 <tr><td>PoissonNoise</td><td> </td></tr>
3270 <tr><td>Uniform-noise</td><td> </td></tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3271
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]3272 <tr><td> </td><td> </td></tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3273
3274 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3275 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3276 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3277 </tbody>
3278 </table>
3279
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3280<p>The specified functions are applied only to each previously set <a href="command-line-options.html#channel">-channel</a> in the image. If necessary, the results of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3281calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3282represented as a 'alpha' values (0 = fully transparent), so, for example, a
3283<code>Divide</code> by 2 of the alpha channel will make the image
3284semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3285as a percentage of the <var>QuantumRange</var>.</p>
3286
3287<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3288<a href="command-line-options.html#list">-list evaluate</a>.</p>
3289
3290<p>The results of the <code>Add</code>, <code>Subtract</code> and
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3291<code>Multiply</code> methods can also be achieved using either the <a href="command-line-options.html#level">-level</a> or the <a href="command-line-options.html#level">+level</a> operator, with
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3292appropriate argument, to linearly modify the overall range of color values.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3293Please note, however, that <a href="command-line-options.html#level">-level</a> treats transparency as
3294'matte' values (0 = opaque), while <a href="command-line-options.html#level">-evaluate</a> works with
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3295'alpha' values.</p>
3296
3297<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3298addition modulo the <var>QuantumRange</var>. It is therefore
3299equivalent to <code>Add</code> unless the resulting pixel value is outside the
3300interval [0, <var>QuantumRange</var>]. </p>
3301
3302<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3303works on normalized pixel values. The <var>value</var> used with
3304<code>Exp</code> should be negative so as to produce a decaying exponential
3305function. Non-negative values will always produce results larger unity and
3306thus outside the interval [0, <var>QuantumRange</var>]. The
3307formula is expressed below. </p>
3308
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]3309<p class="text-center">
3310exp(<var>value</var> × <b><var>u</var></b>)
3311</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3312
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3313<p> If the input image is squared, for example, using <a href="command-line-options.html#-function">-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3314the result.</p>
3315
3316<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3317normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3318factor</var> that adjusts the curvature in the graph of the log function. The
3319formula applied to a normalized value <b><var>u</var></b> is below. </p>
3320
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]3321<p class="text-center">
3322log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3323</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3324
3325<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3326normalized pixel values. Note that <code>Pow</code> is related to the <a href="command-line-options.html#gamma">-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3327to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3328with <a href="command-line-options.html#gamma">-gamma</a> is simply the reciprocal of the value used
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3329with <code>Pow</code>.</p>
3330
3331<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3332converts the image values into a value according to a (co)sine wave function.
3333The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3334is biased 50% and normalized by 50% so as to fit in the respective color value
3335range. The <var>value</var> scaling of the <var>period</var> of the
3336function (its frequency), and thus determines the number of 'waves' that will
3337be 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,
3338then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3339
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]3340<p class="text-center">
33410.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3342</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3343
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3344<p>See also the <a href="command-line-options.html#function">-function</a> operator, which is a
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3345multi-value version of evaluate. </p>
3346
3347<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3348 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3349</div>
3350
3351<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3352logical expression over a sequence of images.</p>
3353
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3354<p>To print a complete list of <a href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a href="command-line-options.html#list">-list evaluate</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3355
3356<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3357 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3358</div>
3359
3360<p class="magick-description">Set the image size and offset.</p>
3361
3362<p>If the image is enlarged, unfilled areas are set to the background color.
3363To position the image, use offsets in the <var>geometry</var>
3364specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3365specify how to compose the image with the background, use <a href="command-line-options.html#compose">-compose</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3366
3367<p>This command reduces or expands a JPEG image to fit on an 800x600
3368display. If the aspect ratio of the input image isn't exactly 4:3, then the
3369image is centered on an 800x600 black canvas: </p>
3370
3371<pre>
3372convert input.jpg -resize 800x600 -background black -compose Copy \
3373 -gravity center -extent 800x600 -quality 92 output.jpg
3374</pre>
3375
3376<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3377
3378<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3379 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3380</div>
3381
3382<p class="magick-description">Extract the specified area from image.</p>
3383
3384<p>This option is most useful for extracting a subregion of a very large raw
3385image. Note that these two commands are equivalent:</p>
3386
3387<pre>
3388convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3389 image.rgb image.png",
3390convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3391 image.rgb image.png"
3392</pre>
3393
3394<p>If you omit the offsets, as in</p>
3395
3396<pre>
3397convert -size 16000x16000 -depth 8 -extract 640x480 \
3398 image.rgb image.png
3399</pre>
3400
3401<p>the image is <var>resized</var> to the specified dimensions instead,
3402equivalent to:</p>
3403
3404<pre>
3405convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3406</pre>
3407
3408<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3409
3410<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3411 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3412</div>
3413
3414<p class="magick-description">Set a font family for text.</p>
3415
3416<p>This setting suggests a font family that ImageMagick should try to use for
3417rendering text. If the family can be found it is used; if not, a default font
3418(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3419"Courier" might be used if "System" is requested but not found). </p>
3420
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3421<p>For other settings that affect fonts, see the options <a href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3422
3423<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3424 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3425</div>
3426
3427<p class="magick-description">display (cooccurrence 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>
3428
3429<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]3430Angular Second Moment Sum Entropy
3431Contrast Entropy
3432Correlation Difference Variance
3433Sum of Squares Variance Difference Entropy
3434Inverse Difference Moment Information Measure of Correlation 1
3435Sum Average Information Measure of Correlation 2
3436Sum Variance Maximum Correlation Coefficient
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3437</pre>
3438
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3439<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3440 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3441</div>
3442
3443<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3444
3445<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3446users in ImageMagick 6.6.0-9). It transforms an image from the normal
3447(spatial) domain to the frequency domain. In the frequency domain, an image is
3448represented as a superposition of complex sinusoidal waves of varying
3449amplitudes. The image x and y coordinates are the possible frequencies along
3450the x and y directions, respectively, and the pixel intensity values are
3451complex numbers that correspond to the sinusoidal wave amplitudes. See for
3452example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3453Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3454Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3455Transform</a>.</p>
3456
3457<p>A single image name is provided as output for this option. However, the
3458output result will have two components. It is either a two-frame image or two
3459separate images, depending upon whether the image format specified supports
3460multi-frame images. The reason that we get a dual output result is because the
3461frequency domain represents an image using complex numbers, which cannot be
3462visualized directly. Therefore, the complex values are automagically separated
3463into a two-component image representation. The first component is the
3464magnitude of the complex number and the second is the phase of the complex
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3465number. See for example, <a href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3466
3467<p>The magnitude and phase component images must be specified using image
3468formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3469PFM, EXR and PNG are the recommended image formats to use. All of these
3470formats, except PNG support multi-frame images. So for example,</p>
3471
3472<pre>
3473convert image.png -fft fft_image.miff
3474</pre>
3475
3476<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3477image as <code>fft_image.miff[1]</code>. Similarly,</p>
3478
3479<pre>
3480convert image.png -fft fft_image.png
3481</pre>
3482
3483<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3484as <code>fft_image-1.png</code>. If you prefer this representation, then you can
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3485force any of the other formats to produce two output images by including <a href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3486
3487<p>The input image can be any size, but if not square and even-dimensioned, it
3488is padded automagically to the larger of the width or height of the input
3489image and to an even number of pixels. The padding will occur at the bottom
3490and/or right sides of the input image. The resulting output magnitude and
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3491phase images is square at this size. The kind of padding relies on the <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3492
3493<p>Both output components will have dynamic ranges that fit within
3494[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3495Phase values nominally range from 0 to 2*π, but is scaled to span the full
3496dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3497scaled). The magnitude image is not scaled and thus generally will contain
3498very small values. As such, the image normally will appear totally black. In
3499order to view any detail, the magnitude image typically is enhanced with a log
3500function into what is usually called the spectrum. A log function is used to
3501enhance the darker values more in comparison to the lighter values. This can
3502be done, for example, as follows:</p>
3503
3504<pre>
3505convert fft_image.miff[0] -contrast-stretch 0 \
3506 -evaluate log 1000 fft_image_spectrum.png"
3507</pre>
3508
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3509<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3510range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3511typically is specified between 100 and 10,000, depending upon the amount of
3512detail that one wants to bring out in the spectrum. Larger values produce more
3513visible detail. Too much detail, however, may hide the important features.</p>
3514
3515<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3516use <a href="command-line-options.html#fft">-fft</a>.</p>
3517
3518<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3519and imaginary components of the complex valued Fourier transform.</p>
3520
3521<p>However, as the real and imaginary components can contain negative values,
3522this requires that IM be configured with HDRI enabled. In this case, you must
3523use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3524results, since they are formats that preserve both negative and fractional
3525values without clipping them or truncating the fractional part. With either
3526MIFF or TIF, one should add -define quantum:format=32, to allow those image
3527types to work properly in HDRI mode without clipping.</p>
3528
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3529<p>The real and imaginary component images resulting from <a href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3530padding that was discussed above for the magnitude and phase component
3531images.</p>
3532
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3533<p>See the discussion on HDRI implementations of ImageMagick on the page <a href="high-dynamic-range.html">High Dynamic-Range Images</a>. For more
3534about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages, <a href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html">Fred's Fourier Processing With ImageMagick page</a> or this <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3535 entry. </p>
3536
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3537<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 explicityly normalize the FFT and unnormalize the IFT.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3538
3539
3540<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3541 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3542</div>
3543
3544<p class="magick-description">color to use when filling a graphic primitive.</p>
3545
3546<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3547HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html">Color Names</a> for
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3548a description of how to properly specify the color argument.</p>
3549
3550<p>Enclose the color specification in quotation marks to prevent the "#" or
3551the parentheses from being interpreted by your shell.</p>
3552
3553<p>For example,</p>
3554
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3555<pre>
3556-fill blue
3557-fill "#ddddff"
3558-fill "rgb(255,255,255)"
3559</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3560
3561<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3562
3563<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3564
3565<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3566 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3567</div>
3568
3569<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3570
3571<p>Use this option to affect the resizing operation of an image during
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3572operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort">-distort</a>. For example you can use a simple resize filter such as:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3573
3574<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3575Point Hermite Cubic
3576Box Gaussian Catrom
3577Triangle Quadratic Mitchell
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3578</pre>
3579
3580<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3581as a faster <code>SincFast</code> equivalent form). However these filters are
3582generally useless on their own as they are infinite filters that are being
3583clipped to the filters support size. Their direct use is not recommended
3584except via expert settings (see below). </p>
3585
3586<p>Instead these special filter functions are typically windowed by a windowing
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3587function that the <a href="command-line-options.html#filter">-filter</a> setting defines. That is
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3588using these functions will define a 'Windowed' filter, appropriate to the
3589operator involved. Windowed filters include: </p>
3590
3591<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3592Lanczos Hamming Parzen
3593Blackman Kaiser Welsh
3594Hanning Bartlett Bohman
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3595</pre>
3596
3597<p>Also one special self-windowing filter is also provided
3598<code>Lagrange</code>, which will automagically re-adjust its function depending
3599on the current 'support' or 'lobes' expert settings (see below).</p>
3600
3601<p>If you do not select a filter with this option, the filter defaults to
3602<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3603if the image is enlarged. Otherwise the filter default to
3604<code>Lanczos</code>.</p>
3605
3606<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3607filter</a> option.</p>
3608
3609<p>You can modify how the filter behaves as it scales your image through the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3610use of these expert settings (see also <a href="command-line-options.html#define">-define</a> and <a href="command-line-options.html#set">-set</a>):-</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3611
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3612<table class="table table-condensed table-striped">
3613 <tr>
3614 <td>-define filter:blur=<var>factor</var></td>
3615 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3616 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3617 Gaussian-like filters simple filters, or you may not get the expected
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3618 results. </td>
3619 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3620
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3621 <tr>
3622 <td>-define filter:support=<var>radius</var></td>
3623 <td>Set the filter support radius. Defines how large the filter should be and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3624 thus directly defines how slow the filtered resampling process is. All
3625 filters have a default 'prefered' support size. Some filters like
3626 <code>Lagrange</code> and windowed filters adjust themselves depending on
3627 this value. With simple filters this value either does nothing (but slow
3628 the resampling), or will clip the filter function in a detrimental way.
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3629 </td>
3630 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3631
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3632 <tr>
3633 <td>-define filter:lobes=<var>count</var></td>
3634 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3635 alternative way of specifying the 'support' range of the filter, that is
3636 designed to be more suited to windowed filters, especially when used for
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3637 image distorts.</td>
3638 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3639
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3640 <tr>
3641 <td>-define filter:sigma=<var>value</var></td>
3642 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3643 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3644 does not shrink (but may enlarge) the filter's 'support'. It can be used
3645 to generate very small blurs but without the filter 'missing' pixels due
3646 to using a small support setting. A larger value of '<code>0.707</code>'
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3647 (a value of '1/sqrt(2)') is another common setting. </td>
3648 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3649
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3650 <tr>
3651 <td>-define filter:b=<var>b-spline_factor</var></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3652 </tr><tr>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3653 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3654 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3655 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3656 the <code>Parzen</code> cubic windowing function. If only one of the values
3657 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3658 The values meaning was defined by a research paper by
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3659 Mitchell-Netravali.</td>
3660 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3661
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3662 <tr>
3663 <td>-define filter:kaiser-beta=<var>value</var></td>
3664 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3665 Default value is '6.5'. It only effects Kaiser windowing function, and
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3666 does not effect any other attributes.
3667 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3668 inheritance from the very old "zoom" program). It was changed to bring the
3669 function in line with more modern academic research usage, and better
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3670 assign it be more definitive. </td>
3671 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3672
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3673 <tr>
3674 <td>-define filter:kaiser-alpha=<var>value</var></td>
3675 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3676 will override that setting. It only effects Kaiser windowing function,
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3677 and does not effect any other attributes. </td>
3678 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3679
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3680 <tr>
3681 <td>-define filter:filter=<var>filter_function</var></td>
3682 <td>Use this function directly as the weighting filter. This will allow
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3683 you to directly use a windowing function such as <code>Blackman</code>,
3684 as a resampling filter, rather than as its normal usage as a windowing
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3685 function. If defined, no windowing function also defined, the window function is set
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3686 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3687 as a filter will also do this. </td>
3688 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3689
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3690 <tr>
3691 <td>-define filter:window=<var>filter_function</var></td>
3692 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3693 <code>Jinc</code> are windowed (brought down to zero over the defined
3694 support range) with the given filter. This allows you to specify a filter
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3695 function to be used as a windowing function for these IIR filters.
3696 Many of the defined filters are actually windowing functions for these IIR
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3697 filters. A typical choices is <code>Box</code>, (which effectively turns
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3698 off the windowing function). </td>
3699 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3700
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3701 <tr>
3702 <td>-define filter:win-support=<var>radius</var></td>
3703 <td>Scale windowing function to this size instead. This causes the windowing
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3704 (or self-windowing Lagrange filter) to act is if the support window is
3705 larger than what is actually supplied to the calling operator. The filter
3706 however is still clipped to the real support size given. If unset this
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3707 will equal the normal filter support size. </td>
3708 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3709
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3710 <tr>
3711 <td>-define filter:verbose=<var>1</var></td>
3712 <td>This causes IM to print information on the final internal filter
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3713 selection to standard output. This includes a commented header on the
3714 filter settings being used, and data allowing the filter weights to be
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3715 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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3716 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
3717 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3718 with specific 'B' and 'C' settings. </td>
3719 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3720
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3721</table>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3722
3723<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
3724
3725<pre>
3726convert image.png \
3727 -filter sinc \
3728 -set filter:window=jinc \
3729 -set filter:lobes=8 \
3730 -resize 150% image.jpg"
3731</pre>
3732
3733<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3734
3735<pre>
3736convert image.png \
3737 -set filter:filter=sinc \
3738 -set filter:lobes=4 \
3739 -resize 150% image.jpg"
3740</pre>
3741
3742<p>To extract the data for a raw windowing function, combine it with
3743a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
3744windowing function. </p>
3745
3746<pre>
3747convert null: -define filter:filter=Box \
3748 -define filter:window=Welch \
3749 -define filter:support=1.0 \
3750 -define filter:verbose=1 \
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3751 -resize 2 null: &gt; window_welch.dat
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3752gnuplot
3753 set grid
3754 plot \"window_welch.dat\" with lines
3755</pre>
3756
3757<p>Note that the use of expert options is provided for image processing experts
3758who have studied and understand how resize filters work. Without this
3759knowledge, and an understanding of the definition of the actual filters
3760involved, using expert settings are more likely to be detrimental to your image
3761resizing.</p>
3762
3763
3764<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3765 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3766</div>
3767
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3768<p class="magick-description">This is a simple alias for the <a href="command-line-options.html#layers">-layers</a> method "flatten".</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3769
3770
3771<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3772 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3773</div>
3774
3775<p class="magick-description">create a <var>mirror image</var></p>
3776
3777<p>reflect the scanlines in the vertical direction. The image will be mirrored
3778upside-down. </p>
3779
3780
3781<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3782 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3783</div>
3784
3785<p class="magick-description">floodfill the image with color at the specified offset.</p>
3786
3787<p>Flood fill starts from the given 'seed point' which is not gravity effected.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3788Any color that matches within <a href="command-line-options.html#fuzz">-fuzz</a> color distance of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3789given <var>color</var> argument, connected to that 'seed point'
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3790will be replaced with the current <a href="command-line-options.html#fill">-fill</a> color. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3791
3792<p>Note that if the pixel at the 'seed point' does not itself match the given
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3793<var>color</var> (according to <a href="command-line-options.html#fuzz">-fuzz</a>), then no
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3794action will be taken. </p>
3795
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3796<p>This operator works more like the <a href="command-line-options.html#opaque">-opaque</a> option, than
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3797a more general flood fill that reads the matching color directly at the 'seed
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3798point'. For this form of flood fill, look at <a href="command-line-options.html#draw">-draw</a> and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3799its 'color floodfill' drawing method. </p>
3800
3801
3802<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3803 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3804</div>
3805
3806<p class="magick-description">create a <var>mirror image</var>.</p>
3807
3808<p>Reflect the scanlines in the horizontal direction, just like the image in
3809a vertical mirror. </p>
3810
3811
3812<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3813 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3814</div>
3815
3816<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
3817
3818<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
3819option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
3820
3821<p>In addition to the fonts specified by the above pre-defined list, you can
3822also specify a font from a specific source. For example <code>Arial.ttf</code>
3823is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
3824<code>x:fixed</code> is X11 font.</p>
3825
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3826<p>For other settings that affect fonts, see the options <a href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3827
3828
3829<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3830 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3831</div>
3832
3833<p class="magick-description">Define the foreground color for menus.", "display</p>
3834
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3835<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3836
3837<p>The default foreground color is black.</p>
3838
3839<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3840 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3841</div>
3842
3843<p class="magick-description">the image format type.</p>
3844
3845<p>When used with the <code>mogrify</code> utility, this option converts any
3846image to the image <a href="formats.html">format</a> you specify.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3847For a list of image format types supported by ImageMagick, use <a href="command-line-options.html#list">-list format</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3848
3849<p>By default the file is written to its original name. However, if the
3850filename extension matches a supported format, the extension is replaced with
3851the image format type specified with <a href="command-line-options.html#format">-format</a>. For
3852example, if you specify <var>tiff</var> as the format type and the
3853input image filename is <var>image.gif</var>, the output image
3854filename becomes <var>image.tiff</var>.</p>
3855
3856<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3857 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3858</div>
3859
3860<p class="magick-description">output formatted image characteristics.</p>
3861
3862<p>See <a href="escape.html">Format and Print Image
3863Properties</a> for an explanation on how to specify the argument to this
3864option.</p>
3865
3866<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3867 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3868</div>
3869
3870<p class="magick-description">Surround the image with a border or beveled frame.</p>
3871
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3872<p>The color of the border is specified with the <a href="command-line-options.html#mattecolor">-mattecolor</a> command line option. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3873
3874<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
3875height that is added to the dimensions of the image. If no offsets are given
3876in the <var>geometry</var> argument, then the border added is
3877a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
3878the width and height of the border is partitioned to form an outer bevel of
3879thickness <var>x</var> pixels and an inner bevel of thickness
3880<var>y</var> pixels. Negative offsets make no sense as frame arguments.
3881</p>
3882
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3883<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3884'<code>Over</code>' composition method. It generates an image of the appropriate
3885size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3886draws the frame of four distinct colors close to the current <a href="command-line-options.html#mattecolor">-mattecolor</a>. The original image is then overlaid onto
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3887center of this image. This means that with the default compose method of
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3888'<code>Over</code>' any transparent parts may be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3889
3890<p>The image composition is not
3891affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
3892
3893
3894<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3895 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3896</div>
3897
3898<p class="magick-description">include the X window frame in the imported image. </p>
3899<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3900 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3901</div>
3902
3903<p class="magick-description">Apply a function to channel values.</p>
3904
3905<p>This operator performs calculations based on the given arguments to modify
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3906each of the color values for each previously set <a href="command-line-options.html#channel">-channel</a> in the image. See <a href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3907calculations are handled.</p>
3908
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3909<p>This is can be considered a multi-argument version of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3910ImageMagick 6.4.8−8.)</p>
3911
3912<p>Here, <var>parameters</var> is a comma-separated list of
3913numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
3914
3915<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3916Polynomial
3917Sinusoid
3918Arcsin
3919Arctan
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3920</pre>
3921
3922<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
3923use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
3924
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3925<dl class="dl-horizontal">
3926 <dt>Polynomial</dt>
3927 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3928these being the coefficients of a polynomial, in decreasing order of degree.
3929That is, entering</p>
3930
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3931<pre>
3932-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>
3933</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3934
3935<p>will invoke a polynomial function given by</p>
3936
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3937<pre>
3938<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>,
3939</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3940
3941<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
3942
3943<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
3944(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
3945<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]3946polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3947correspondences follow.</p>
3948
3949<table class="table table-condensed table-striped">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3950 <tr>
3951 <td>-evaluate Set <var>value</var> </td>
3952 <td>-function Polynomial <var>value</var></td>
3953 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
3954 </tr>
3955 <tr>
3956 <td>-evaluate Add <var>value</var> </td>
3957 <td>-function Polynomial 1,<var>value</var></td>
3958 </tr>
3959 <tr>
3960 <td>-evaluate Subtract <var>value</var> </td>
3961 <td>-function Polynomial 1,−<var>value</var></td>
3962 </tr>
3963 <tr>
3964 <td>-evaluate Multiply <var>value</var> </td>
3965 <td>-function Polynomial <var>value</var>,0</td>
3966 </tr>
3967 <tr>
3968 <td>+level black% x white%</td>
3969 <td>-function Polynomial A,B</td>
3970 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3971 </tr>
3972</table>
3973
3974<p>The <code>Polynomial</code> function gives great versatility, since
3975polynomials can be used to fit any continuous curve to any degree of accuracy
3976desired.</p>
3977
3978</dd>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3979<dt>Sinusoid</dt>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3980<dd>
3981<p>The <code>Sinusoid</code> function can be used to vary the channel values
3982sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
3983values are given as one to four parameters, as follows,</p>
3984
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3985<pre>
3986-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
3987</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3988
3989<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
3990corresponds to 0 through <var>freq</var>×360 degrees.)
3991The result is that if a pixel's normalized channel value is originally
3992<b><var>u</var></b>, its resulting normalized value is given by </p>
3993
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3994<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3995<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]3996</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]3997
3998<p> For example, the following generates a curve that starts and ends at 0.9
3999(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4000.7−.2=.5 and .7+.2=.9. </p>
4001
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4002<pre>
4003-function Sinusoid 3,-90,.2,.7
4004</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4005
4006<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4007is 0.</p>
4008
4009<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4010<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4011varying amplitude, phase and bias. The correspondence is as follows.</p>
4012
4013<table class="table table-condensed table-striped">
4014 <tr>
4015 <td>-evaluate Sin <var>freq</var> </td>
4016 <td>-function Sinusoid <var>freq</var>,0 </td>
4017 </tr>
4018 <tr>
4019 <td>-evaluate Cos <var>freq</var> </td>
4020 <td>-function Sinusoid <var>freq</var>,90 </td>
4021 </tr>
4022</table>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4023 </dd>
4024<dt>ArcSin</dt>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4025<dd>
4026<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4027and can be used to generate cylindrical distortion and displacement maps.
4028The curve can be adjusted relative to both the input values and output range
4029of values.</p>
4030
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4031<pre>
4032-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4033</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4034
4035<p>with all values given in terms of normalized color values (0.0 for black,
40361.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4037for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4038
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4039<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4040<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4041</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4042
4043</dd>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4044<dt>ArcTan</dt>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4045<dd>
4046<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4047limit values at infinities, though a center using the given slope value.
4048All these values can be adjusted via the arguments.</p>
4049
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4050<pre>
4051-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4052</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4053
4054<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4055</p>
4056
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4057<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4058<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4059</pre>
4060 </dd>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4061
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4062</dl>
4063
4064
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4065
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4066<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4067 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4068</div>
4069
4070<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4071
4072<p>A number of algorithms search for a target color. By default the color must
4073be exact. Use this option to match colors that are close to the target color
4074in RGB space. For example, if you want to automagically trim the edges of an
4075image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4076background color may differ by a small amount. This option can account for
4077these differences.</p>
4078
4079<p>The <var>distance</var> can be in absolute intensity units or, by
4080appending <code>%</code> as a percentage of the maximum possible intensity (255,
408165535, or 4294967295).</p>
4082
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4083<p>Use <a href="command-line-options.html#fuzz">+fuzz</a> to reset the fuzz value to 0.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4084
4085
4086<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4087 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4088</div>
4089
4090<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4091
4092<p>If the first character of <var>expression</var> is <code>@</code>,
4093the expression is read from a file titled by the remaining characters in the
4094string.</p>
4095
4096<p>See <a href="fx.html">FX,
4097The Special Effects Image Operator</a> for a detailed discussion of this
4098option.</p>
4099
4100
4101<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4102 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4103</div>
4104
4105<p class="magick-description">level of gamma correction.</p>
4106
4107<p>The same color image displayed on two different workstations may look
4108different due to differences in the display monitor. Use gamma correction to
4109adjust for this color difference. Reasonable values extend from
4110<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4111gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4112result in the loss of some image information if the pixel quantum size is only
4113eight bits (quantum range 0 to 255).</p>
4114
4115<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4116a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4117normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4118same as taking the square root of the image.</p>
4119
4120<p>You can apply separate gamma values to the red, green, and blue channels of
4121the image with a gamma value list delimited with commas (e.g.,
4122<code>1.7,2.3,1.2</code>).</p>
4123
4124<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4125image gamma level without actually adjusting the image pixels. This option
4126is useful if the image is of a known gamma but not set as an image attribute
4127(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4128display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4129chunk, use</p>
4130
4131<pre>
4132convert input.png +gamma .45455 output.png
4133</pre>
4134
4135<p>(0.45455 is 1/2.2)</p>
4136
4137<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4138
4139<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4140 <h3 class="magick-header"><a id="gaussian-blur"></a>-gaussian-blur <var>radius</var><br>-gaussian-blur <var>radius</var>x<var>sigma</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4141</div>
4142
4143<p class="magick-description">Blur the image with a Gaussian operator.</p>
4144
4145<p>Convolve the image with a Gaussian or normal distribution using the given
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4146<var>Sigma</var> value. The formula is:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4147
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]4148<p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"> </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4149
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4150<p>The <var>Sigma</var> value is the important argument, and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4151determines the actual amount of blurring that will take place. </p>
4152
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4153<p>The <var>Radius</var> is only used to determine the size of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4154array which will hold the calculated Gaussian distribution. It should be an
4155integer. If not given, or set to zero, IM will calculate the largest possible
4156radius that will provide meaningful results for the Gaussian distribution.
4157</p>
4158
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4159<p>The larger the <var>Radius</var> the radius the slower the
4160operation is. However too small a <var>Radius</var>, and sever
4161aliasing effects may result. As a guideline, <var>Radius</var>
4162should be at least twice the <var>Sigma</var> value, though three
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4163times will produce a more accurate result. </p>
4164
4165<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4166full 2-dimensional convolution is used to generate the weighted average of the
4167neighboring pixels. </p>
4168
4169<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4170pixels which are outside the image proper are blurred into the final result.
4171</p>
4172
4173
4174<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4175 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4176</div>
4177
4178<p class="magick-description">Set the preferred size and location of the image.</p>
4179
4180<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4181
4182<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4183 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4184</div>
4185
4186<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4187
4188<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4189<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4190<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a href="command-line-options.html#list">-list gravity</a> to get a complete list of <a href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4191installation.</p>
4192
4193<p>The direction you choose specifies where to position text or subimages. For
4194example, a gravity of <code>Center</code> forces the text to be centered within
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4195the image. By default, the image gravity is <code>NorthWest</code>. See <a href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4196text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4197
4198<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4199<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4200take <var>geometry</var> as an argument, such as the <a href="command-line-options.html#crop">-crop</a> option. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4201
4202<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4203or setting having a <var>geometry</var> argument that specifies an
4204offset, the offset is usually applied to the point within the image suggested
4205by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4206command, for example, suppose the file <code>image.png</code> has dimensions
4207200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4208is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4209<code>Center</code>, which suggests the midpoint of the image, at the point
4210(100,50). The offset (−40,20) is applied to that point, giving
4211(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4212that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4213region itself, which is <var>centered</var> at the pixel
4214coordinate (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>
4215
4216<pre>
4217convert image.png -gravity Center -region 10x10-40+20 \
4218 -negate output.png
4219</pre>
4220
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4221<p>When used as an option to <a href="composite.html">composite</a>, <a href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4222within the composite.</p>
4223
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4224<p>When used as an option to <a href="montage.html">montage</a>, <a href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4225within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4226
4227
4228<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4229 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4230</div>
4231
4232<p class="magick-description">convert image to grayscale.</p>
4233
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4234<p>This will use one of the <a href="command-line-options.html#intensity">-intensity</a> methods to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4235convert the given image into a linear-grayscale image. </p>
4236
4237<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4238
4239<pre>
4240convert in.png -grayscale Rec709Luminance out.png
4241</pre>
4242
4243<p>which is equivalent to:</p>
4244
4245<pre>
4246convert in.png -colorspace gray out.png
4247</pre>
4248
4249<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4250
4251<pre>
4252convert in.png -grayscale Rec709Luma out.png
4253</pre>
4254
4255<p>which is equivalent to:</p>
4256
4257<pre>
4258convert in.png -set colorspace RGB -colorspace gray out.png
4259</pre>
4260
4261<p>Note that a 'colorspace' intensity method will produce the same result
4262regardless of the current colorpsace of the image. But a 'mathematical'
4263intensity method will depend on the current colorspace the image is currently
4264using. </p>
4265
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4266<p>While this operation uses an <a href="command-line-options.html#intensity">-intensity</a> method,
4267it does not use or set the <a href="command-line-options.html#intensity">-intensity</a> setting, so
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4268will not effect other operations that may use that setting.</p>
4269
4270
4271<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4272 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4273</div>
4274
4275<p class="magick-description">green chromaticity primary point.</p>
4276
4277
4278<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4279 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4280</div>
4281
4282<p class="magick-description">apply a Hald color lookup table to the image.</p>
4283
4284<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4285dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4286can apply any color transformation to the Hald image and then use this option
4287to apply the transform to the image. </p>
4288
4289<pre>
4290convert image.png hald.png -hald-clut transform.png
4291</pre>
4292
4293<p>This option provides a convenient method for you to use Gimp or Photoshop
4294to make color corrections to the Hald CLUT image and subsequently apply them
4295to multiple images using an ImageMagick script. </p>
4296
4297<p>Note that the representation is only of the normal RGB color space and that
4298the whole color value triplet is used for the interpolated lookup of the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4299represented Hald color cube image. Because of this the operation is not <a href="command-line-options.html#channel">-channel</a> setting effected, nor can it adjust or modify an
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4300images transparency or alpha/matte channel.</p>
4301
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4302<p>See also <a href="command-line-options.html#clut">-clut</a> which provides color value replacement
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4303of the individual color channels, usually involving a simpler gray-scale
4304image. E.g: gray-scale to color replacement, or modification by a histogram
4305mapping. </p>
4306
4307
4308<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4309 <h3 class="magick-header"><a id="help"></a>-help</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4310</div>
4311
4312<p class="magick-description">print usage instructions.</p>
4313
4314<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4315 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4316</div>
4317
4318<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4319
4320<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4321 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4322</div>
4323
4324<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4325
4326<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4327
4328<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>.
4329
4330<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>
4331
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4332<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4333
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4334<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4335
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4336<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4337
4338<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4339
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4340<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4341
4342<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4343 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4344</div>
4345
4346<p class="magick-description">specify the icon geometry.</p>
4347
4348<p>Offsets, if present in the geometry specification, are handled in the same
4349manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4350handle negative offsets.</p>
4351
4352<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4353
4354<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4355 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4356</div>
4357
4358<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4359
4360<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4361 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4362</div>
4363
4364<p class="magick-description">identify the format and characteristics of the image.</p>
4365
4366<p>This information is printed: image scene number; image name; image size;
4367the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4368number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4369a description of the image class.</p>
4370
4371<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4372in the image and color reduction error values are printed. Refer to <a href="quantize.html">color
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4373reduction algorithm</a> for a description of these values.</p>
4374
4375<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4376amounts of image properties are displayed including image statistics, profiles,
4377image histogram, and others.</p>
4378
4379<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4380 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4381</div>
4382
4383<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4384
4385<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4386users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4387images from the frequency domain to a single image in the normal or spatial
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4388domain. See for example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4389<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4390<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4391
4392<p>For example, depending upon the image format used to store the result of
4393the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4394
4395<pre>
4396convert fft_image.miff -ift fft_image_ift.png
4397</pre>
4398
4399<p>or</p>
4400
4401<pre>
4402convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4403</pre>
4404
4405<p>The resulting image may need to be cropped due to padding introduced when
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4406the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4407the right and/or bottom sides of the image.</p>
4408
4409<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4410use <a href="command-line-options.html#ift">-ift</a>.</p>
4411
4412<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4413and imaginary images from the frequency domain to a single image in the normal
4414(spatial) domain.</p>
4415
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4416<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 explictly normalize the IFT and unnormalize the FFT.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4417
4418<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4419 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4420</div>
4421
4422<p class="magick-description">make image immutable.</p>
4423
4424<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4425 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4426</div>
4427
4428<p class="magick-description">implode image pixels about the center.</p>
4429
4430<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4431 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4432</div>
4433
4434<p class="magick-description">insert the last image into the image sequence.</p>
4435
4436<p>This option takes last image in the current image sequence and inserts it
4437at the given index. If a negative index is used, the insert position is
4438calculated before the last image is removed from the sequence. As such
4439<code>-insert -1</code> will result in no change to the image sequence.</p>
4440
4441<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4442other words, insert the last image, at the end of the current image sequence.
4443Consequently this has no effect on the image sequence order.</p>
4444
4445<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4446 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4447</div>
4448
4449<p class="magick-description">method to generate intensity value from pixel.</p>
4450
4451<p>ImageMagick provides a number of methods used in situations where an
4452operatory needs to determine a single grayscale value for some purpose, from
4453an image with red, green, and blue pixel components. Typically the linear
4454<code>Rec709Luminance</code> formula is used, which is the same formula used when
4455converting images to <code>-colorspace gray</code>. </p>
4456
4457<p>The following formulas are currently provided, and will first convert
4458the pixel values to linear-RGB or non-linear sRGB colorspace before
4459being applied to calulate the final greyscale value. </p>
4460
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]4461<dl class="dl-horizontal">
4462<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4463<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4464<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4465<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4466<dt>Brightness</dt><dd> max(R', G', B')</dd>
4467<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4468</dl>
4469
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4470<p>Note that the above R,G,B values is the image's linear-RGB values, while
4471R',G',B' are sRGB non-linear values. </p>
4472
4473<p>These intensity methods are mathematical in nature and will use the
4474current value in the images respective R,G,B channel regardless of
4475what that is, or what colorspace the image is currently using.</p>
4476
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]4477<dl class="dl-horizontal">
4478<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4479<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4480<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4481</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4482
4483<p>These methods are often used for other purposes, such as generating a
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4484grayscale difference image between two color images (using <a href="command-line-options.html#compose">-compose</a> '<code>Difference</code>' composition. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4485
4486<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4487error comparisions. While... The method 'RMS' (Root Mean Squared) for
4488example is appropriate for calculating color vector distance, from a color
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4489difference image. This is equivalent to the color only component of the <a href="command-line-options.html#fuzz">-fuzz</a> factor color compare setting. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4490
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4491<p>See also <a href="command-line-options.html#grayscale">-grayscale</a> which applies one of the above
4492grayscaling formula directly to an image without setting the <a href="command-line-options.html#intensity">-intensity</a> setting.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4493
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4494<p>The <a href="command-line-options.html#colorspace">-colorspace gray</a> image conversion also uses
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4495the current intensity setting, but will always convert the image to the
4496appropriate sRGB or linear-RGB colorspace before appling the above
4497function.</p>
4498
4499<p>To print a complete list of posible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4500
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4501<p>Operators affected by the <a href="command-line-options.html#intensity">-intensity</a> setting include:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4502
4503<pre>
4504-adaptive-blur
4505-adaptive-sharpen
4506-black-threshold
4507-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4508-colors for gray colorspace
4509-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4510-contrast-stretch
4511-distort {ErodeIntensity, DilateIntensity}
4512-normalize
4513-random-threshold
4514-selective-blur
4515-shade
4516-threshold
4517-tint
4518-white-threshold
4519</pre>
4520
4521<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4522 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4523</div>
4524
4525<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4526
4527<p>Use this option to affect the color management operation of an image (see
4528<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4529Perceptual, Relative, Saturation</code>.</p>
4530
4531<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4532
4533<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4534
4535<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4536 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4537</div>
4538
4539<p class="magick-description">the type of interlacing scheme.</p>
4540
4541<p>Choose from:</p>
4542
4543<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]4544none
4545line
4546plane
4547partition
4548JPEG
4549GIF
4550PNG
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4551</pre>
4552
4553<p>This option is used to specify the type of interlacing scheme for raw image
4554formats such as <code>RGB</code> or <code>YUV</code>.</p>
4555
4556<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4557
4558<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4559
4560<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4561
4562<p><code>Partition</code> is like plane except the different planes are saved to
4563individual files (e.g. image.R, image.G, and image.B).</p>
4564
4565<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4566PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4567
4568<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4569interlace</a>.</p>
4570
4571<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4572 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4573</div>
4574
4575<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>
4576
4577<p>When looking up the color of a pixel using a non-integer floating point
4578value, you typically fall in between the pixel colors defined by the source
4579image. This setting determines how the color is determined from the colors of
4580the pixels surrounding that point. That is how to determine the color of a
4581point that falls between two, or even four different colored pixels. </p>
4582
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4583<dl class="dl-horizontal">
4584 <dt>integer</dt>
4585 <dd>The color of the top-left pixel (floor function)</dd>
4586 <dt>nearest-neighbor</dt>
4587 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4588 <dt>average</dt>
4589 <dd>The average color of the surrounding four pixels</dd>
4590 <dt>bilinear</dt>
4591 <dd>A double linear interpolation of pixels (the default)</dd>
4592 <dt>mesh</dt>
4593 <dd>Divide area into two flat triangular interpolations</dd>
4594 <dt>bicubic</dt>
4595 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4596 <dt>spline</dt>
4597 <dd>Direct spline curves (colors are blurred)</dd>
4598 <dt>filter</dt>
4599 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4600</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4601
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4602<p>This most important for distortion operators such as <a href="command-line-options.html#distort">-distort</a>, <a href="command-line-options.html#implode">-implode</a>, <a href="command-line-options.html#transform">-transform</a> and <a href="command-line-options.html#fx">-fx</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4603
4604<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4605
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4606<p>See also <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a>, for control of the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4607lookup for positions outside the boundaries of the image. </p>
4608
4609
4610<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4611 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4612</div>
4613
4614<p class="magick-description">the space between two text lines.</p>
4615
4616<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4617 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4618</div>
4619
4620<p class="magick-description">the space between two words.</p>
4621
4622<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4623 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4624</div>
4625
4626<p class="magick-description">the space between two letters.</p>
4627
4628<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4629 <h3 class="magick-header"><a id="kuwahara"></a>-kuwahara <var>radius</var><br>-kuwahara <var>radius</var>x<var>sigma</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4630</div>
4631
4632<p class="magick-description">edge preserving noise reduction filter.</p>
4633
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4634<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4635
4636
4637<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4638 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4639</div>
4640
4641<p class="magick-description">assign a label to an image.</p>
4642
4643<p>Use this option to assign a specific label to the image, as it is read in
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4644or created. You can use the <a href="command-line-options.html#set">-set</a> operation to re-assign
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4645a the labels of images already read in. Image formats such as TIFF, PNG,
4646MIFF, supports saving the label information with the image.</p>
4647
4648<p>When saving an image to a <var>PostScript</var> file, any label
4649assigned to an image is used as a header string to print above the postscript
4650image. </p>
4651
4652<p>You can include the image filename, type, width, height, or other image
4653attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4654Properties</a> for details of the percent escape codes.</p>
4655
4656<p>For example,</p>
4657
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4658<pre>
4659-label "%m:%f %wx%h" bird.miff
4660</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4661
4662<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4663"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4664is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4665existing label present in the image would be used. You can remove all labels
4666from an image by assigning the empty string. </p>
4667
4668<p>A label is not drawn on the image, but is embedded in the image datastream
4669via <var>Label</var> tag or similar mechanism. If you want the label to be
4670visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4671during the final processing in the creation of an image montage.</p>
4672
4673<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4674remaining characters in the string. Labels in a file are literal, no embedded
4675formatting characters are recognized.</p>
4676
4677
4678<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4679 <h3 class="magick-header"><a id="lat"></a>-lat <var>width</var><br>-lat <var>width</var>x<var>height</var>{<var>+-</var>}<var>offset</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4680</div>
4681
4682<p class="magick-description">perform local adaptive threshold.</p>
4683
4684<p>Adaptively threshold each pixel based on the value of pixels in a
4685surrounding window. If the current pixel is lighter than this average plus
4686the optional <code>offset</code>, then it is made white, otherwise it is made
4687black. Small variations in pixel values such as found in scanned documents
4688can be ignored if offset is positive. A negative offset will make it more
4689sensitive to those small variations. </p>
4690
4691<p>This is commonly used to threshold images with an uneven background. It is
4692based on the assumption that average color of the small window is the
4693the local background color, from which to separate the foreground color. </p>
4694
4695
4696<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4697 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4698</div>
4699
4700<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
4701
4702<p>Perform various image operation methods to a ordered sequence of images
4703which may represent either a set of overlaid 'image layers', a GIF disposal
4704animation, or a fully-'coalesced' animation sequence. </p>
4705
4706<table class="table table-condensed table-striped">
4707 <tbody>
4708 <tr>
4709 <th style="width: 8%">Method</th>
4710 <th>Description</th>
4711 </tr>
4712
4713 <tr>
4714 <td>compare-any</td>
4715 <td>Crop the second and later frames to the smallest rectangle
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4716 that contains all the differences between the two images. No GIF <a href="command-line-options.html#dispose">-dispose</a> methods are taken into account. </td>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4717 </tr>
4718
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4719 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct">-deconstruct</a> operator, and does not preserve animations normal
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4720 working, especially when animation used layer disposal methods such as
4721 '<code>Previous</code>' or '<code>Background</code>'. </td>
4722 </tr>
4723
4724 <tr>
4725 <td>compare-clear</td>
4726 <td>As '<code>compare-any</code>' but crop to the bounds of any
4727 opaque pixels which become transparent in the second frame. That is the
4728 smallest image needed to mask or erase pixels for the next frame. </td>
4729 </tr>
4730
4731 <tr>
4732 <td>compare-overlay</td>
4733 <td>As '<code>compare-any</code>' but crop to pixels that add
4734 extra color to the next image, as a result of overlaying color pixels.
4735 That is the smallest single overlaid image to add or change colors. </td>
4736 </tr>
4737
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4738 <tr><td></td><td>This can be used with the <a href="command-line-options.html#compose">-compose</a> alpha
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4739 composition method '<code>change-mask</code>', to reduce the image to
4740 just the pixels that need to be overlaid. </td>
4741 </tr>
4742
4743 <tr>
4744 <td>coalesce</td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4745 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce">-coalesce</a> operator. Apply the layer disposal methods set in the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4746 current image sequence to form a fully defined animation sequence, as
4747 it should be displayed. Effectively converting a GIF animation into a
4748 'film strip'-like animation. </td>
4749 </tr>
4750
4751 <tr>
4752 <td>composite</td>
4753 <td>Alpha Composition of two image lists, separated by a
4754 "<code>null:</code>" image, with the destination image list first, and
4755 the source images last. An image from each list are composited
4756 together until one list is finished. The separator image and source
4757 image lists are removed. </td>
4758 </tr>
4759
4760
4761 <tr><td></td>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4762 <td>The <a href="command-line-options.html#geometry">-geometry</a> offset is adjusted according
4763 to <a href="command-line-options.html#gravity">-gravity</a> in accordance of the virtual
4764 canvas size of the first image in each list. Unlike a normal <a href="command-line-options.html#composite">-composite</a> operation, the canvas offset is also
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4765 added to the final composite positioning of each image. </td> </tr>
4766
4767 <tr><td></td>
4768 <td>If one of the image lists only contains one image, that image is
4769 applied to all the images in the other image list, regardless of which
4770 list it is. In this case it is the image meta-data of the list which
4771 preserved. </td>
4772 </tr>
4773
4774
4775 <tr>
4776 <td>dispose</td>
4777 <td>This like '<code>coalesce</code>' but shows the look of
4778 the animation after the layer disposal method has been applied, before
4779 the next sub-frame image is overlaid. That is the 'dispose' image that
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4780 results from the application of the GIF <a href="command-line-options.html#dispose">-dispose</a> method. This allows you to check what
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4781 is going wrong with a particular animation you may be developing.
4782 </td>
4783 </tr>
4784
4785 <tr>
4786 <td>flatten</td>
4787 <td>Create a canvas the size of the first images virtual
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4788 canvas using the current <a href="command-line-options.html#background">-background</a> color,
4789 and <a href="command-line-options.html#compose">-compose</a> each image in turn onto that
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4790 canvas. Images falling outside that canvas is clipped. Final
4791 image will have a zero virtual canvas offset. </td>
4792 </tr>
4793
4794 <tr><td></td>
4795 <td>This usually used as one of the final 'image layering' operations
4796 overlaying all the prepared image layers into a final image. </td>
4797 </tr>
4798
4799 <tr><td></td>
4800 <td>For a single image this method can also be used to fillout a virtual
4801 canvas with real pixels, or to underlay an opaque color to remove
4802 transparency from an image.</td>
4803 </tr>
4804
4805
4806 <tr>
4807 <td>merge</td>
4808 <td>As 'flatten' method but merging all the given image
4809 layers to create a new layer image just large enough to hold all the
4810 image without clipping or extra space. The new images virtual offset
4811 will preserve the position of the new layer, even if this offset is
4812 negative. The virtual canvas size of the first image is preserved.
4813 </td>
4814 </tr>
4815
4816 <tr><td></td><td>Caution is advised when handling image layers with
4817 negative offsets as few image file formats handle them correctly.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4818 Following this operation method with <a href="command-line-options.html#repage">+repage</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4819 will remove the layer offset, and create an image in which all the
4820 overlaid image positions relative to each other is preserved, though
4821 not necessarily exactly where you specified them.
4822 </td>
4823 </tr>
4824
4825 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
4826 without doing the'flatten' to merge the images together. </td>
4827 </tr>
4828
4829 <tr>
4830 <td>mosaic</td>
4831 <td>As 'flatten' method but expanding the initial canvas size
4832 of the first image in a positive direction only so as to hold all the
4833 image layers. However as a virtual canvas is 'locked' to the origin,
4834 by its own definition, image layers with a negative offsets will still
4835 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
4836 if this could be a problem. </td>
4837
4838 </tr>
4839
4840 <tr><td></td><td>This method is commonly used to layout individual image
4841 using various offset but without knowing the final canvas size. The
4842 resulting image will, like 'flatten' not have any virtual offset, so
4843 can be saved to any image file format. </td>
4844 </tr>
4845
4846
4847 <tr>
4848 <td>optimize</td>
4849 <td>Optimize a coalesced animation, into GIF animation using
4850 a number of general techniques. This currently a short cut to
4851 apply both the '<code>optimize-frame</code>', and
4852 '<code>optimize-transparency</code>' methods but may be expanded to
4853 include other optimization methods as they are developed. </td>
4854 </tr>
4855
4856 <tr>
4857 <td>optimize-frame</td>
4858 <td>Optimize a coalesced animation, into GIF animation by
4859 reducing the number of pixels per frame as much as possible by
4860 attempting to pick the best layer disposal method to use, while ensuring
4861 the result will continue to animate properly. </td>
4862 </tr>
4863
4864 <tr><td></td><td> There is no guarantee that the best optimization is found.
4865 But then no reasonably fast GIF optimization algorithm can do this.
4866 However this does seem to do better than most other GIF frame
4867 optimizers seen. </td>
4868 </tr>
4869
4870 <tr>
4871 <td>optimize-plus</td>
4872 <td>As '<code>optimize-frame</code>' but attempt to improve the
4873 overall optimization by adding extra frames to the animation, without
4874 changing the final look or timing of the animation. The frames are
4875 added to attempt to separate the clearing of pixels from the
4876 overlaying of new additional pixels from one animation frame to the
4877 next. If this does not improve the optimization (for the next frame
4878 only), it will fall back to the results of the previous normal
4879 '<code>optimize-frame</code>' technique. </td>
4880 </tr>
4881
4882 <tr><td></td><td>There is the possibility that the change in the disposal
4883 style will result in a worsening in the optimization of later frames,
4884 though this is unlikely. In other words there no guarantee that it is
4885 better than the normal '<code>optimize-frame</code>' technique. For some
4886 animations however you can get a vast improvement in the final
4887 animation size. </td>
4888 </tr>
4889
4890 <tr>
4891 <td>optimize-transparency</td>
4892 <td>Given a GIF animation, replace any pixel in the sub-frame
4893 overlay images with transparency, if it does not change the resulting
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4894 animation by more than the current <a href="command-line-options.html#fuzz">-fuzz</a> factor.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4895 </td>
4896 </tr>
4897
4898 <tr><td></td><td>This should allow a existing frame optimized GIF animation
4899 to compress into a smaller file size due to larger areas of one
4900 (transparent) color rather than a pattern of multiple colors repeating
4901 the current disposed image of the last frame. </td>
4902 </tr>
4903
4904 <tr>
4905 <td>remove-dups</td>
4906 <td>Remove (and merge time delays) of duplicate consecutive
4907 images, so as to simplify layer overlays of coalesced animations.
4908 </td>
4909 </tr>
4910
4911 <tr><td></td><td>Usually this a result of using a constant time delay
4912 across the whole animation, or after a larger animation was split into
4913 smaller sub-animations. The duplicate frames could also have been
4914 used as part of some frame optimization methods. </td>
4915 </tr>
4916
4917 <tr>
4918 <td>remove-zero</td>
4919 <td>Remove any image with a zero time delay, unless ALL the
4920 images have a zero time delay (and is not a proper timed animation, a
4921 warning is then issued). </td>
4922 </tr>
4923
4924 <tr><td></td><td>In a GIF animation, such images are usually frames which
4925 provide partial intermediary updates between the frames that are
4926 actually displayed to users. These frames are usually added for
4927 improved frame optimization in GIF animations. </td>
4928 </tr>
4929
4930 <tr>
4931 <td>trim-bounds</td>
4932 <td>Find the bounds of all the images in the current
4933 image sequence, then adjust the offsets so all images are contained on
4934 a minimal positive canvas. None of the image data is modified or
4935 merged, only the individual image virtual canvas size and offset.
4936 All the images is given the same canvas size, and and will have
4937 a positive offset, but will remain in the same position relative to
4938 each other. As a result of the minimal canvas size at least one image
4939 will touch every edge of that canvas. The image data touching those
4940 edges however may be transparent. </td>
4941 </tr>
4942
4943 <tr><td></td><td>The result is much like if you used 'merge' followed by a
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4944 <a href="command-line-options.html#repage">+repage</a> option, except that all the images
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4945 have been kept separate. If 'flatten' is used after using
4946 'trim-bounds' you will get the same result. </td>
4947 </tr>
4948
4949 </tbody>
4950</table>
4951
4952<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
4953
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4954<p>The operators <a href="command-line-options.html#coalesce">-coalesce</a>, <a href="command-line-options.html#deconstruct">-deconstruct</a>, <a href="command-line-options.html#flatten">-flatten</a>, and <a href="command-line-options.html#mosaic">-mosaic</a> are only aliases for the above methods and may be depreciated in
4955the future. Also see <a href="command-line-options.html#page">-page</a>, <a href="command-line-options.html#repage">-repage</a> operators, the <a href="command-line-options.html#compose">-compose</a> setting, and the
4956GIF <a href="command-line-options.html#dispose">-dispose</a> and <a href="command-line-options.html#delay">-delay</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4957settings. </p>
4958
4959
4960<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4961 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4962</div>
4963
4964<p class="magick-description">adjust the level of image channels.</p>
4965
4966<p>Given one, two or three values delimited with commas: black-point,
4967white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
4968white points range from 0 to <var>QuantumRange</var>, or from 0 to
4969100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
4970If a <code>%</code> sign is present anywhere in the string, both black and white
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]4971points are percentages of the full color range. Gamma will do a <a href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4972default of 1.0 (no gamma correction) is assumed.</p>
4973
4974<p>In normal usage (<code>-level</code>) the image values are stretched so that
4975the given '<code>black_point</code>' value in the original image is set to zero
4976(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
4977contrast adjustments to the image. The '<code>gamma</code>' of the resulting
4978image will then be adjusted. </p>
4979
4980<p>From ImageMagick v6.4.1-9 using the plus form of the operator
4981(<code>+level</code>) or adding the special '!' flag anywhere in the argument
4982list, will cause the operator to do the reverse of the level adjustment. That
4983is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
4984in the original image, is adjusted to the given level values, allowing you to
4985de-contrast, or compress the channel values within the image. The
4986'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
4987image is made. </p>
4988
4989<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
4990setting are adjusted (defaults to RGB color channels only), allowing you to
4991limit the effect of this operator. </p>
4992
4993<p>Please note that the transparency channel is treated as 'matte'
4994values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4995
4996
4997<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]4998 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]4999</div>
5000
5001<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5002
5003<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5004value value for each color channel is determined by the
5005'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5006described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5007
5008<p>This effectually means the colors provided to <code>-level-colors</code>
5009is mapped to become 'black' and 'white' respectively, with all the other
5010colors linearly adjusted (or clipped) to match that change. Each channel is
5011adjusted separately using the channel values of the colors specified. </p>
5012
5013<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5014will map the image color 'black' and 'white' to the given colors
5015respectively, resulting in a gradient (de-contrasting) tint of the image to
5016those colors. This can also be used to convert a plain gray-scale image into a
5017one using the gradient of colors specified. </p>
5018
5019<p>By supplying a single color with a comma separator either before or after
5020that color, will just replace the respective 'black' or 'white' point
5021respectively. But if no comma separator is provided, the given color is
5022used for both the black and white color points, making the operator either
5023threshold the images around that color (- form) or set all colors to that
5024color (+ form). </p>
5025
5026
5027<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5028 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5029</div>
5030
5031<p class="magick-description">Set the pixel cache resource limit.</p>
5032
5033<p>Choose from: <code>area</code>, <code>disk</code>, <code>file</code>,
5034<code>map</code>, <code>memory</code>, <code>thread</code>, or <code>time</code>.</p>
5035
5036<p>The value for <code>file</code> is in number of files. The other limits are
5037in bytes. Define arguments for the memory, map, area, and disk resource limits
5038with SI prefixes (.e.g 100MB).</p>
5039
5040<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5041memory map, and 18.45EB of disk. These limits are adjusted relative to the
5042available resources on your computer if this information is available. When
5043any limit is reached, ImageMagick fails in some fashion but attempts to take
5044compensating actions, if possible. For example, the following limits
5045memory:</p>
5046
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5047<pre>
5048-limit memory 32MiB -limit map 64MiB
5049</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5050
5051<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>
5052
5053<pre>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5054-&gt; identify -list resource
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5055Resource limits:
5056 Width: 100MP
5057 Height: 100MP
5058 Area: 25.181GB
5059 Memory: 11.726GiB
5060 Map: 23.452GiB
5061 Disk: unlimited
5062 File: 768
5063 Thread: 12
5064 Throttle: 0
5065 Time: unlimited
5066</pre>
5067
5068<p>Requests for pixel storage to keep intermediate images are satisfied by one
5069of three resource categories: in-memory pool, memory-mapped files pool, and
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5070disk pool (in that order) depending on the <a href="command-line-options.html#limit">‑limit</a> settings
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5071and whether the system honors a resource request. If the total size of
5072allocated pixel storage in the given pool reaches the corresponding limit, the
5073request is passed to the next pool. Additionally, requests that exceed the
5074<code>area</code> limit automagically are allocated on disk.</p>
5075
5076<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5077image resource request. First, ImageMagick tries to allocate the pixels in
5078memory. The request might be denied if the resource request exceeds the
5079<code>memory</code> limit or if the system does not honor the request. If
5080a memory request is not honored, the pixels are allocated to disk and the file
5081is memory-mapped. However, if the allocation request exceeds the
5082<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5083the resource request exceeds the <code>area</code> limit, the pixels are
5084automagically cached to disk. If the disk has a hard limit, the program
5085fails.</p>
5086
5087<p>In most cases you simply do not need to concern yourself with resource
5088limits. ImageMagick chooses reasonable defaults and most images do not tax
5089your computer resources. Where limits do come in handy is when you process
5090images that are large or on shared systems where ImageMagick can consume all
5091or most of the available memory. In this case, the ImageMagick workflow slows
5092other processes or, in extreme cases, brings the system to a halt. Under
5093these circumstances, setting limits give some assurances that the ImageMagick
5094workflow will not interfere with other concurrent uses of the computer. For
5095example, assume you have a web interface that processes images uploaded from
5096the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5097simply set the area limit to 10MiB:</p>
5098
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5099<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5100-limit area 10MB
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5101</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5102
5103<p>Now whenever a large image is processed, the pixels are automagically
5104cached to disk instead of memory. This of course implies that large images
5105typically process very slowly, simply because pixel processing in memory can
5106be an order of magnitude faster than on disk. Because your web site users
5107might inadvertently upload a huge image to process, you should set a disk
5108limit as well:</p>
5109
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5110<pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5111-limit area 10MB -limit disk 500MB
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5112</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5113
5114<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5115
5116<p>In addition to command-line resource limit option, resources can be set
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5117with <a href="resources.html#environment">environment variables</a>. Set the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5118environment variables <code>MAGICK_AREA_LIMIT</code>,
5119<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5120<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5121<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5122image area, disk space, open files, heap memory, memory map, number of threads
5123of execution, and maximum elapsed time in seconds respectively.</p>
5124
5125<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5126their commands and then scouring the generated output for references to the
5127pixel cache, in order to determine how the pixel cache was allocated and how
5128resources were consumed. Advanced Unix/Linux users can pipe that output
5129through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5130</p>
5131
5132<p>For more about ImageMagick's use of resources, see the section <b>Cache
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5133Storage and Resource Requirements</b> on the <a href="architecture.html#cache%0A">Architecture</a> page. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5134
5135<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5136 <h3 class="magick-header"><a id="linear-stretch"></a>-linear-stretch <var>black-point</var><br>-linear-stretch <var>black-point</var>{x<var>white-point</var>}{<var>%</var>}}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5137</div>
5138
5139<p class="magick-description">Linear with saturation stretch.</p>
5140
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5141<p>This is very similar to <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5142and uses a 'histogram bin' to determine the range of color values that needs to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5143be stretched. However it then stretches those colors using the <a href="command-line-options.html#level">-level</a> operator.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5144
5145<p>As such while the initial determination may have 'binning' round off
5146effects, the image colors are stretched mathematically, rather than using the
5147histogram bins. This makes the operator more accurate. </p>
5148
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5149<p>note however that a <a href="command-line-options.html#linear-stretch">-linear-stretch</a> of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5150'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5151perfect stretch of the color range. </p>
5152
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5153<p>See also <a href="command-line-options.html#auto-level">-auto-level</a> for a 'perfect'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5154normalization of mathematical images. </p>
5155
5156<p>This operator is under review for re-development. </p>
5157
5158
5159<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5160 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5161</div>
5162
5163<p class="magick-description">the line width for subsequent draw operations.</p>
5164
5165<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5166 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5167</div>
5168
5169<p class="magick-description">rescale image with seam-carving.</p>
5170
5171<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5172
5173<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5174 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5175</div>
5176
5177<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5178
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5179<pre class="pre-scrollable">
5180Align
5181Alpha
5182Boolean
5183Cache
5184Channel
5185Class
5186ClipPath
5187Coder
5188Color
5189Colorspace
5190Command
5191Complex
5192Compose
5193Compress
5194Configure
5195DataType
5196Debug
5197Decoration
5198Delegate
5199Direction
5200Dispose
5201Distort
5202Dither
5203Endian
5204Evaluate
5205FillRule
5206Filter
5207Font
5208Format
5209Function
5210Gravity
5211Intensity
5212Intent
5213Interlace
5214Interpolate
5215Kernel
5216Layers
5217LineCap
5218LineJoin
5219List
5220Locale
5221LogEvent
5222Log
5223Magic
5224Method
5225Metric
5226Mime
5227Mode
5228Morphology
5229Module
5230Noise
5231Orientation
5232PixelIntensity
5233Policy
5234PolicyDomain
5235PolicyRights
5236Preview
5237Primitive
5238QuantumFormat
5239Resource
5240SparseColor
5241Statistic
5242Storage
5243Stretch
5244Style
5245Threshold
5246Type
5247Units
5248Validate
5249VirtualPixel
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5250</pre>
5251
5252<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5253list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5254available:</p>
5255
5256<pre>
5257identify -list list
5258</pre>
5259
5260<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5261 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5262</div>
5263
5264<p class="magick-description">Specify format for debug log.</p>
5265
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5266<p>This option specifies the format for the log printed when the <a href="command-line-options.html#debug">-debug</a> option is active.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5267
5268<p>You can display the following components by embedding special format
5269characters:</p>
5270
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5271<dl class="dl-horizontal">
5272<dt>%d</dt><dd>domain</dd>
5273<dt>%e</dt><dd>event</dd>
5274<dt>%f</dt><dd>function</dd>
5275<dt>%l</dt><dd>line</dd>
5276<dt>%m</dt><dd>module</dd>
5277<dt>%p</dt><dd>process ID</dd>
5278<dt>%r</dt><dd>real CPU time</dd>
5279<dt>%t</dt><dd>wall clock time</dd>
5280<dt>%u</dt><dd>user CPU time</dd>
5281<dt>%%</dt><dd>percent sign</dd>
5282<dt>\n</dt><dd>newline</dd>
5283<dt>\r</dt><dd>carriage return</dd>
5284</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5285
5286<p>For example:</p>
5287
5288<pre>
5289convert -debug coders -log "%u %m:%l %e" in.gif out.png
5290</pre>
5291
5292<p>The default behavior is to print all of the components.</p>
5293
5294<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5295 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5296</div>
5297
5298<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5299
5300<p>Set iterations to zero to repeat the animation an infinite number of times,
5301otherwise the animation repeats itself up to <var>iterations</var>
5302times.</p>
5303
5304<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5305 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5306</div>
5307
5308<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5309
5310<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5311 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5312</div>
5313
5314<p class="magick-description">double the size of the image with pixel art scaling.</p>
5315
5316
5317<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5318 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5319</div>
5320
5321<p class="magick-description">Display image using this <var>type</var>.</p>
5322
5323<p>Choose from these <var>Standard Colormap</var> types:</p>
5324
5325<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5326best
5327default
5328gray
5329red
5330green
5331blue
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5332</pre>
5333
5334<p>The <var>X server</var> must support the <var>Standard
5335Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5336the type and <code>display</code> searches the list of colormap types in
5337<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5338
5339
5340<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5341 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5342</div>
5343
5344<p class="magick-description">pixel map.</p>
5345
5346<p>Here are the valid components of a map:</p>
5347
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5348<dl class="dl-horizontal">
5349<dt>r</dt><dd> red pixel component</dd>
5350<dt>g</dt><dd> green pixel component</dd>
5351<dt>b</dt><dd> blue pixel component</dd>
5352<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5353<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5354<dt>i</dt><dd> grayscale intensity pixel component</dd>
5355<dt>c</dt><dd> cyan pixel component</dd>
5356<dt>m</dt><dd> magenta pixel component</dd>
5357<dt>y</dt><dd> yellow pixel component</dd>
5358<dt>k</dt><dd> black pixel component</dd>
5359<dt>p</dt><dd> pad component (always 0)</dd>
5360</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5361
5362<p>You can specify as many of these components as needed in any order (e.g.
5363bgr). The components can repeat as well (e.g. rgbr).</p>
5364
5365
5366<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5367 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5368</div>
5369
5370<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5371
5372<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5373
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5374<p>The default matte color is <code>#BDBDBD</code>, <span style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5375
5376<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5377 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5378</div>
5379
5380<p class="magick-description">return the maximum intensity of an image sequence.</p>
5381
5382<p>Select the 'maximum' value from all the surrounding pixels. </p>
5383
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5384<p>This is legacy option from the <a href="command-line-options.html#statistic">method</a> of the same
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5385name. </p>
5386
5387<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5388 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5389</div>
5390
5391<p class="magick-description">apply a median filter to the image.</p>
5392
5393<p>Select the 'middle' value from all the surrounding pixels. </p>
5394
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5395<p>This is legacy option from the <a href="command-line-options.html#statistic">method</a> of the same
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5396name. </p>
5397
5398<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5399 <h3 class="magick-header"><a id="mean-shift"></a>-mean-shift <var>width</var>x<var>height</var>{<var>+distance</var>{%}}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5400</div>
5401
5402<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5403
5404<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>
5405
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5406<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5407
5408<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5409 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5410</div>
5411
5412<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5413
5414<p>Choose from:</p>
5415
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5416<dl class="dl-horizontal">
5417<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5418<dt>FUZZ</dt><dd> mean color distance</dd>
5419<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5420<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5421<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5422<dt>NCC</dt><dd> normalized cross correlation</dd>
5423<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
5424<dt>PHASH</dt><dd> perceptual hash</dd>
5425<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5426<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5427</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5428
5429<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5430with the <a href="command-line-options.html#fuzz">-fuzz</a> factor (ignore pixels which
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5431only changed by a small amount). Use '<code>PAE</code>' to find the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5432size of the <a href="command-line-options.html#fuzz">-fuzz</a> factor needed to make all pixels
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5433'similar', while '<code>MAE</code>' determines the factor needed
5434for about half the pixels to be similar. </p>
5435
5436<p>The '<code>MEPP</code>' metric returns three different metrics
5437('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5438normalized) from a single comparison run. </p>
5439
5440<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5441metric</a> option.</p>
5442
5443
5444<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5445 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5446</div>
5447
5448<p class="magick-description">return the minimum intensity of an image sequence.</p>
5449
5450<p>Select the 'minimal' value from all the surrounding pixels. </p>
5451
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5452<p>This is legacy option from the <a href="command-line-options.html#statistic">method</a> of the same
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5453name. </p>
5454
5455
5456
5457<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5458 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5459</div>
5460
5461<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5462
5463<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5464 <h3 class="magick-header">-mode <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5465</div>
5466
5467<p class="magick-description">Mode of operation.</p>
5468
5469<p>Choose the <var>value</var> from these styles: <code>Frame,
5470Unframe, or Concatenate</code></p>
5471
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5472<p>Use the <a href="command-line-options.html#list">-list</a> option with a '<code>Mode</code>' argument
5473for a list of <a href="command-line-options.html#mode">-mode</a> arguments available in your
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5474ImageMagick installation.</p>
5475
5476
5477<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5478 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5479</div>
5480
5481<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5482
5483<p>The arguments are given as a percentages of variation. A value of 100 means
5484no change, and any missing values are taken to mean 100.</p>
5485
5486<p>The <var>brightness</var> is a multiplier of the overall
5487brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5488twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5489before and after. </p>
5490
5491<p>The <var>saturation</var> controls the amount of color in an
5492image. For example, 0 produce a grayscale image, while a large value such as
5493200 produce a very colorful, 'cartoonish' color.</p>
5494
5495<p>The <var>hue</var> argument causes a "rotation" of the colors
5496within the image by the amount specified. For example, 50 results in
5497a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5498A value of either 0 or 200 results in a complete 180 degree rotation of the
5499image. Using a value of 300 is a 360 degree rotation resulting in no change to
5500the original image. </p>
5501
5502<p>For example, to increase the color brightness by 20% and decrease the color
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5503saturation by 10% and leave the hue unchanged, use <a href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5504
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5505<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code>option:modulate:colorspace</code>' to specify which colorspace to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5506modulate. 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>
5507
5508<pre>
5509convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5510</pre>
5511
5512<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5513 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5514</div>
5515
5516<p class="magick-description">report image moments and perceptual hash.</p>
5517
5518
5519<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5520 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5521</div>
5522
5523<p class="magick-description">monitor progress.</p>
5524
5525
5526<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5527 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5528</div>
5529
5530<p class="magick-description">transform the image to black and white.</p>
5531
5532<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5533 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5534</div>
5535
5536<p class="magick-description">morphs an image sequence.</p>
5537
5538<p>Both the image pixels and size are linearly interpolated to give the
5539appearance of a metamorphosis from one image to the next, over all the images
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5540in the current image list. The added images are the equivalent of a <a href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5541argument determine how many images to interpolate between each image. </p>
5542
5543
5544<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5545 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5546 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5547</div>
5548
5549<p class="magick-description">apply a morphology method to the image.</p>
5550
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5551<p>Until I get around to writing an option summary for this, see <a href="http://www.imagemagick.org/Usage/morphology/">IM Usage Examples,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5552Morphology</a>. </p>
5553
5554
5555<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5556 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5557</div>
5558
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5559<p class="magick-description">an simple alias for the <a href="command-line-options.html#layers">-layers</a> method "mosaic"</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5560
5561
5562<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5563 <h3 class="magick-header"><a id="motion-blur"></a>-motion-blur <var>radius</var><br>-motion-blur <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5564</div>
5565
5566<p class="magick-description">simulate motion blur.</p>
5567
5568<p>Blur with the given radius, standard deviation (sigma), and angle. The
5569angle given is the angle toward which the image is blurred. That is the
5570direction people would consider the object is coming from. </p>
5571
5572<p>Note that the blur is not uniform distribution, giving the motion a
5573definite sense of direction of movement. </p>
5574
5575<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5576pixels which are outside the image proper are blurred into the final result.
5577</p>
5578
5579<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5580 <h3 class="magick-header"><a id="name"></a>-name</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5581</div>
5582
5583<p class="magick-description">name an image.</p>
5584<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5585 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5586</div>
5587
5588<p class="magick-description">replace each pixel with its complementary color.</p>
5589
5590<p>The red, green, and blue intensities of an image are negated. White becomes
5591black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5592negate the grayscale pixels of the image.</p>
5593
5594<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5595 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5596 +noise <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5597</div>
5598
5599<p class="magick-description">Add or reduce noise in an image.</p>
5600
5601<p>The principal function of noise peak elimination filter is to smooth the
5602objects within an image without losing edge information and without creating
5603undesired structures. The central idea of the algorithm is to replace a pixel
5604with its next neighbor in value within a pixel window, if this pixel has been
5605found to be noise. A pixel is defined as noise if and only if this pixel is
5606a maximum or minimum within the pixel window.</p>
5607
5608<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5609specify the width of the neighborhood when reducing noise. This is equivalent
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5610to using a <code><a href="command-line-options.html#statistic">-statistic</a> NonPeak</code> operation,
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5611which should be used in preference.</p>
5612
5613<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
5614types:</p>
5615
5616<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5617Gaussian
5618Impulse
5619Laplacian
5620Multiplicative
5621Poisson
5622Random
5623Uniform
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5624</pre>
5625
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5626<p>The amount of noise added can be controled by the <code><a href="command-line-options.html#attunuuate">-attenuate</a></code> setting. If unset the value is
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5627equivalent to 1.0, or a maximum noise addition.</p>
5628
5629<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>
5630
5631<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5632
5633<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5634the use of a controlling value to specify the amount of noise that should be
5635added to an image. </p>
5636
5637
5638<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5639 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5640</div>
5641
5642<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5643
5644<p>The intensity values are stretched to cover the entire range of possible
5645values. While doing so, black-out at most <var>2%</var> of the pixels and
5646white-out at most <var>1%</var> of the pixels.</p>
5647
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5648<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize">-normalize</a>
5649is equivalent to <a href="command-line-options.html#contrast-stretch">-contrast-stretch 2%x1%</a>.
5650(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch">-contrast-stretch 2%x99%</a>).</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5651
5652<p>All the channels are normalized in concert by the came amount so as to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5653preserve color integrity, when the default <a href="command-line-options.html#channel">+channel</a>
5654setting is in use. Specifying any other <a href="command-line-options.html#channel">-channel</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5655setting will normalize the RGB channels independently.</p>
5656
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5657<p>See <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> for more details.
5658Also see <a href="command-line-options.html#auto-level">-auto-level</a> for a 'perfect' normalization
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5659that is better suited to mathematically generated images. </p>
5660
5661<p>This operator is under review for re-development. </p>
5662
5663
5664<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5665 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5666</div>
5667
5668<p class="magick-description">change this color to the fill color within the image.</p>
5669
5670<p>The <var>color</var> argument is defined using the format
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5671described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz">-fuzz</a> setting can be used to match and replace colors similar to the one
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5672given.</p>
5673
5674<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
5675the target color. </p>
5676
5677<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5678as <a href="command-line-options.html#opaque">-opaque</a> but replaces the matching color with
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5679transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
5680To ensure that it can do this it also ensures that the image has an alpha
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5681channel enabled, as per "<code><a href="command-line-options.html#alpha">-alpha</a> set</code>", for
5682the new transparent colors, and does not require you to modify the <a href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5683
5684
5685<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5686 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5687</div>
5688
5689<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
5690given number of <var>levels</var> per color channel.</p>
5691
5692<p>You can choose from these standard threshold maps:</p>
5693
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5694<pre class="pre-scrollable">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5695threshold 1x1 Threshold 1x1 (non-dither)
5696checks 2x1 Checkerboard 2x1 (dither)
5697o2x2 2x2 Ordered 2x2 (dispersed)
5698o3x3 3x3 Ordered 3x3 (dispersed)
5699o4x4 4x4 Ordered 4x4 (dispersed)
5700o8x8 8x8 Ordered 8x8 (dispersed)
5701h3x4a 4x1 Halftone 4x4 (angled)
5702h6x6a 6x1 Halftone 6x6 (angled)
5703h8x8a 8x1 Halftone 8x8 (angled)
5704h3x4o Halftone 4x4 (orthogonal)
5705h6x6o Halftone 6x6 (orthogonal)
5706h8x8o Halftone 8x8 (orthogonal)
5707h36x16o Halftone 16x16 (orthogonal)
5708c5x5b c5x5 Circles 5x5 (black)
5709c5x5w Circles 5x5 (white)
5710c6x6b c6x6 Circles 6x6 (black)
5711c6x6w Circles 6x6 (white)
5712c7x7b c7x7 Circles 7x7 (black)
5713c7x7w Circles 7x7 (white)
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5714</pre>
5715
5716<p> The <code>threshold</code> generated a simple 50% threshold of the image.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5717This could be used with <var>level</var> to do the equivalent of <a href="command-line-options.html#posterize">-posterize</a> to reduce an image to basic primary colors.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5718</p>
5719
5720<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
5721pattern. That is a grayscale will become a pattern of solid black, solid
5722white, and mid-tone colors into a checkerboard pattern of black and white.
5723</p>
5724
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5725<p>You can define your own <var>threshold map</var> for ordered
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5726dithering and halftoning your images, in either personal or system
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5727<code>thresholds.xml</code> XML file. See <a href="resources.html">Resources</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5728for more details of configuration files. </p>
5729
5730<p>To print a complete list of the thresholds that have been defined, use the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5731<a href="command-line-options.html#list">-list threshold</a> option.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5732
5733<p>Note that at this time the same threshold dithering map is used for all
5734color channels, no attempt is made to offset or rotate the map for different
5735channels is made, to create an offset printing effect. Also as the maps are
5736simple threshold levels, the halftone and circle maps will create incomplete
5737circles along the edges of a colored area. Also all the effects are purely
5738on/off boolean effects, without anti-aliasing to make the circles smooth
5739looking. Large dots can be made to look better with a small amount of blurring
5740after being created. </p>
5741
5742
5743<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5744 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5745</div>
5746
5747<p class="magick-description">specify orientation of a digital camera image.</p>
5748
5749<p>Choose from these orientations:</p>
5750
5751<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5752bottom-left right-top
5753bottom-right top-left
5754left-bottom top-right
5755left-top undefined
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5756right-bottom
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5757</pre>
5758
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5759<p>To print a complete list of orientations, use the <a href="command-line-options.html#list">-list
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5760orientation</a> option.</p>
5761
5762
5763<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5764 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br>
5765 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5766 +page
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5767 </h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5768</div>
5769
5770<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
5771
5772<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5773
5774<p>For convenience you can specify the page size using <var>media</var> (see below). Offsets can then be added as with other
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5775<var>geometry</var> arguments (e.g. <a href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5776
5777<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.
5778The choices for a PostScript page are:</p>
5779
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5780<dl class="dl-horizontal">
5781<dt> 11x17 </dt> <dd> 792 x 1224</dd>
5782<dt> Ledger </dt> <dd> 1224 x 792</dd>
5783<dt> Legal </dt> <dd> 612 x 1008</dd>
5784<dt> Letter </dt> <dd> 612 x 792</dd>
5785<dt> LetterSmall</dt> <dd> 612 x 792</dd>
5786<dt> ArchE </dt> <dd> 2592 x 3456</dd>
5787<dt> ArchD </dt> <dd> 1728 x 2592</dd>
5788<dt> ArchC </dt> <dd> 1296 x 1728</dd>
5789<dt> ArchB </dt> <dd> 864 x 1296</dd>
5790<dt> ArchA </dt> <dd> 648 x 864</dd>
5791<dt> A0 </dt> <dd> 2380 x 3368</dd>
5792<dt> A1 </dt> <dd> 1684 x 2380</dd>
5793<dt> A2 </dt> <dd> 1190 x 1684</dd>
5794<dt> A3 </dt> <dd> 842 x 1190</dd>
5795<dt> A4 </dt> <dd> 595 x 842</dd>
5796<dt> A4Small </dt> <dd> 595 x 842</dd>
5797<dt> A5 </dt> <dd> 421 x 595</dd>
5798<dt> A6 </dt> <dd> 297 x 421</dd>
5799<dt> A7 </dt> <dd> 210 x 297</dd>
5800<dt> A8 </dt> <dd> 148 x 210</dd>
5801<dt> A9 </dt> <dd> 105 x 148</dd>
5802<dt> A10 </dt> <dd> 74 x 105</dd>
5803<dt> B0 </dt> <dd> 2836 x 4008</dd>
5804<dt> B1 </dt> <dd> 2004 x 2836</dd>
5805<dt> B2 </dt> <dd> 1418 x 2004</dd>
5806<dt> B3 </dt> <dd> 1002 x 1418</dd>
5807<dt> B4 </dt> <dd> 709 x 1002</dd>
5808<dt> B5 </dt> <dd> 501 x 709</dd>
5809<dt> C0 </dt> <dd> 2600 x 3677</dd>
5810<dt> C1 </dt> <dd> 1837 x 2600</dd>
5811<dt> C2 </dt> <dd> 1298 x 1837</dd>
5812<dt> C3 </dt> <dd> 918 x 1298</dd>
5813<dt> C4 </dt> <dd> 649 x 918</dd>
5814<dt> C5 </dt> <dd> 459 x 649</dd>
5815<dt> C6 </dt> <dd> 323 x 459</dd>
5816<dt> Flsa </dt> <dd> 612 x 936</dd>
5817<dt> Flse </dt> <dd> 612 x 936</dd>
5818<dt> HalfLetter </dt> <dd> 396 x 612</dd>
5819</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5820
5821<p>This option is also used to place subimages when writing to a multi-image
5822format that supports offsets, such as GIF89 and MNG. When used for this
5823purpose the offsets are always measured from the top left corner of the canvas
5824and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
5825position 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
5826file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
5827the sequence with nonzero width and height defines the width and height values
5828that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
5829height are computed from the bounding box that contains all images in the
5830sequence. When writing a GIF89 file, only the bounding box method is used to
5831determine its dimensions.</p>
5832
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]5833<p>For a PostScript page, the image is sized as in <a href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
5834left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5835page. If the image size exceeds the PostScript page, it is reduced to fit the
5836page. 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
5837corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
5838present with a value other than <var>NorthWest</var>.</p>
5839
5840<p>The default page dimensions for a TEXT image is 612x792.</p>
5841
5842<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
5843
5844<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
5845
5846<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5847 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5848</div>
5849
5850<p class="magick-description">simulate an oil painting.</p>
5851
5852<p>Each pixel is replaced by the most frequent color in a circular
5853neighborhood whose width is specified with <var>radius</var>.</p>
5854
5855<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5856 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5857
5858<p class="magick-description">write images to this path on disk.</p>
5859
5860<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5861 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5862</div>
5863
5864<p class="magick-description">Pause between animation loops</p>
5865
5866<p>Pause for the specified number of seconds before repeating the animation.</p>
5867
5868<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5869 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5870</div>
5871
5872<p class="magick-description">Pause between snapshots.</p>
5873
5874<p>Pause for the specified number of seconds before taking the next snapshot.</p>
5875
5876<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5877 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5878</div>
5879
5880<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>
5881
5882<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5883 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5884</div>
5885
5886<p class="magick-description">efficiently determine image characteristics.</p>
5887
5888<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5889 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5890</div>
5891
5892<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
5893
5894<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5895 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5896</div>
5897
5898<p class="magick-description">simulate a Polaroid picture.</p>
5899
5900<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
5901
5902<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5903 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5904</div>
5905
5906<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>
5907
5908<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>
5909
5910<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>
5911
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5912<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5913
5914<p>Some simple uses are:</p>
5915<ul>
5916<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>
5917<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>
5918</ul>
5919
5920<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>
5921
5922<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>
5923
5924
5925<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5926 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5927</div>
5928
5929<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
5930
5931<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
5932visible effect.</p>
5933
5934<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5935 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5936</div>
5937
5938<p class="magick-description">set the maximum number of significant digits to be printed.</p>
5939
5940<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5941 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5942</div>
5943
5944<p class="magick-description">image preview type.</p>
5945
5946<p>Use this option to affect the preview operation of an image (e.g.
5947<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
5948these previews:</p>
5949
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5950<pre class="pre-scrollable">
5951AddNoise
5952Blur
5953Brightness
5954Charcoal
5955Despeckle
5956Dull
5957EdgeDetect
5958Gamma
5959Grayscale
5960Hue
5961Implode
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5962JPEG
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]5963OilPaint
5964Quantize
5965Raise
5966ReduceNoise
5967Roll
5968Rotate
5969Saturation
5970Segment
5971Shade
5972Sharpen
5973Shear
5974Solarize
5975Spiff
5976Spread
5977Swirl
5978Threshold
5979Wave
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5980</pre>
5981
5982<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
5983
5984<p>The default preview is <code>JPEG</code>.</p>
5985
5986<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5987 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5988</div>
5989
5990<p class="magick-description">interpret string and print to console.</p>
5991
5992<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5993 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5994</div>
5995
5996<p class="magick-description">process the image with a custom image filter.</p>
5997
5998<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
5999argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6000"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6001pass to the process module.</p>
6002
6003<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6004 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6005 +profile <var>profile_name</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6006</div>
6007
6008<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6009
6010<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6011ICM (ICC color management), IPTC (newswire information), or a generic profile
6012to the image.</p>
6013
6014<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6015remove the indicated profile. ImageMagick uses standard filename globbing, so
6016wildcard expressions may be used to remove more than one profile. Here we
6017remove all profiles from the image except for the XMP profile: <code>+profile
6018"!xmp,*"</code>. </p>
6019
6020<p>Use <code>identify -verbose</code> to find out which profiles are in the
6021image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6022comments).</p>
6023
6024<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6025used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6026
6027<p>For example, to extract the Exif data (which is stored in JPEG files in the
6028<var>APP1</var> profile), use.</p>
6029
6030<pre>
6031convert cockatoo.jpg profile.exif
6032</pre>
6033
6034<p>It is important to note that results may depend on whether or not the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6035original image already has an included profile. Also, keep in mind that <a href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6036therefore a conversion is made each time it is encountered, in order, in the
6037command-line. For instance, in the following example, if the original image is
6038CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6039
6040<pre>
6041convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6042</pre>
6043
6044<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6045conversion steps can yield unwanted results. CMYK profiles are often very
6046asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6047</p>
6048
6049<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6050 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6051</div>
6052
6053<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6054
6055<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6056highest compression) to 100 (best quality but least effective compression).
6057The default is to use the estimated quality of your input image if it can
6058be determined, otherwise 92. When the quality is greater than 90, then the
6059chroma channels are not downsampled.
6060Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6061factors for chroma downsampling.</p>
6062
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6063<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6064equation to the compression ratio required by the Jasper library. This
6065non-linear equation is intended to loosely approximate the quality provided by
6066the JPEG v1 format. The default quality value 100, a request for non-lossy
6067compression. A quality of 75 results in a request for 16:1 compression.</p>
6068
6069<p>For the MNG and PNG image formats, the quality value sets the zlib
6070compression level (quality / 10) and filter-type (quality % 10). The default
6071PNG "quality" is 75, which means compression level 7 with adaptive PNG
6072filtering, unless the image has a color map, in which case it means
6073compression level 7 with no PNG filtering.</p>
6074
6075<p>For compression level 0 (quality value less than 10), the Huffman-only
6076strategy is used, which is fastest but not necessarily the worst
6077compression.</p>
6078
6079<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6080all scanlines:</p>
6081
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6082<dl class="dl-horizontal">
6083<dt>0</dt><dd>none</dd>
6084<dt>1</dt><dd>sub</dd>
6085<dt>2</dt><dd>up</dd>
6086<dt>3</dt><dd>average</dd>
6087<dt>4</dt><dd>Paeth</dd>
6088</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6089
6090<p>If filter-type is 5, adaptive filtering is used when quality is greater
6091than 50 and the image does not have a color map, otherwise no filtering is
6092used.</p>
6093
6094<p>If filter-type is 6, adaptive filtering
6095with <var>minimum-sum-of-absolute-values</var> is used.</p>
6096
6097<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6098transformation (intrapixel differencing) and adaptive filtering
6099with <var>minimum-sum-of-absolute-values</var> are used.</p>
6100
6101<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6102Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6103adaptive PNG filtering.</p>
6104
6105<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6106Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6107no PNG filtering.</p>
6108
6109<p>The quality setting has no effect on the appearance or signature of PNG
6110and MNG images, since the compression is always lossless.</p>
6111
6112<p>Not all combinations of compression level, strategy, and PNG filter type
6113can be obtained using the -quality option. For more precise control,
6114you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6115PNG:compression-filter=N defines, respectively, instead.
6116See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6117over values from the -quality option.</p>
6118
6119<p>For further information, see
6120the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6121
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]6122<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>
6123
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]6124<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6125
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6126<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6127 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6128</div>
6129
6130<p class="magick-description">reduce colors using this colorspace.</p>
6131
6132<p>This setting defines the colorspace used to sort out and reduce the number
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6133of colors needed by an image (for later dithering) by operators such as <a href="command-line-options.html#colors">-colors</a>, Note that color reduction also happens
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6134automatically when saving images to color-limited image file formats, such as
6135GIF, and PNG8.</p>
6136
6137
6138<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6139 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6140</div>
6141
6142<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6143
6144<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6145 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6146</div>
6147
6148<p class="magick-description">Blur around the center of the image.</p>
6149
6150<p>Note that this is actually a rotational blur rather than a radial and as
6151such actually mis-named. </p>
6152
6153<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6154pixels which are outside the image proper are blurred into the final result.
6155</p>
6156
6157
6158<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6159 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6160</div>
6161
6162<p class="magick-description">Lighten or darken image edges.</p>
6163
6164<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6165a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6166
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6167<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6168
6169<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6170 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6171</div>
6172
6173<p class="magick-description">Apply a random threshold to the image.</p>
6174
6175<div style="margin: auto;">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]6176 <h3 class="magick-header"><a id="read-mask"></a>-read-mask <var>filename</var></h3>
6177</div>
6178
6179<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6180
6181<p>This the same as using a mask used for composite masking operations, with
6182grayscale values causing blended updates of the image the mask is attached to.
6183</p>
6184
6185<p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6186
6187<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6188but with strict boolean masking. </p>
6189
6190<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6191 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6192</div>
6193
6194<p class="magick-description">Set the red chromaticity primary point.</p>
6195
6196<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6197 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6198</div>
6199
6200<p class="magick-description">Pay attention to warning messages.</p>
6201
6202<p>This option causes some warnings in some image formats to be treated
6203as errors. </p>
6204
6205<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6206 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6207</div>
6208
6209<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6210
6211<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6212the given colors are dithered over the image as necessary, otherwise the closest
6213color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6214
6215<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6216images in the current image sequence, all the images will have the same color
6217table. That means that when saved to a file format such as GIF, it will use
6218that color table as a single common or global color table, for all the images,
6219without requiring extra local color tables. </p>
6220
6221<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6222sequence to use a common color map over all the images. This equivalent to
6223appending all the images together (without extra background colors) and color
6224reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6225limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6226images. This ensures all the images follow a single color map. </p>
6227
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6228<p>If the number of colors over all the images is less than 256, then <a href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6229no color changes are needed. In that case, its only effect is to force the use
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6230of a global color table. This recommended after using either <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#ordered-dither">-ordered-dither</a> to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6231reduce the number of colors in an animated image sequence. </p>
6232
6233<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>
6234
6235<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6236 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6237</div>
6238
6239<p class="magick-description">Set a region in which subsequent operations apply.</p>
6240
6241<p>The <var>x</var> and <var>y</var> offsets are treated
6242in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6243
6244<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6245
6246<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6247 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6248</div>
6249
6250<p class="magick-description">perform a remote operation.</p>
6251
6252<p>The only command recognized is the name of an image file to load.</p>
6253
6254<p>If you have more than one <a href="display.html">display</a> application
6255running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6256specify which application to control.</p>
6257
6258<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6259 <h3 class="magick-header"><a id="render"></a>-render</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6260</div>
6261
6262<p class="magick-description">render vector operations.</p>
6263
6264<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6265This useful when saving the result to vector formats such as MVG or SVG.</p>
6266
6267<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6268<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6269</div>
6270
6271<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6272
6273<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6274rather than a setting. You can separately set the canvas size or the offset
6275of the image on that canvas by only providing those components. </p>
6276
6277<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6278
6279<p>If a <code>!</code> flag is given the offset given is added to the existing
6280offset to move the image relative to its previous position. This useful for
6281animation sequences. </p>
6282
6283<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6284recalculate the canvas size so the image (at its current offset) will appear
6285completely on that canvas (unless it has a negative offset).</p>
6286
6287<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6288canvas meta-data from the images. </p>
6289
6290<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6291directly assign virtual canvas meta-data. </p>
6292
6293
6294<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6295 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6296</div>
6297
6298<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6299
6300<p>Resize the image so that its rendered size remains the same as the original
6301at the specified target resolution. For example, if a 300 DPI image renders at
63023 inches by 2 inches on a 300 DPI device, when the image has been resampled to
630372 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6304only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6305storing the image resolution. For formats which do not support an image
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6306resolution, the original resolution of the image must be specified via <a href="command-line-options.html#density">-density</a> on the command line prior to specifying the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6307resample resolution.</p>
6308
6309<p>Note that Photoshop stores and obtains image resolution from a proprietary
6310embedded profile. If this profile exists in the image, then Photoshop will
6311continue to treat the image using its former resolution, ignoring the image
6312resolution specified in the standard file header.</p>
6313
6314<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6315 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6316</div>
6317
6318<p class="magick-description">Resize an image.</p>
6319
6320<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
6321ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6322
6323<p>If the <a href="command-line-options.html#filter">-filter</a> option
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6324or <code>-define filter:option=value</code> precedes the <a href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6325filter.</p>
6326
6327<p>Many image processing algorithms assume your image is in a linear-light
6328coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6329correction, apply the transform, then restore it like this:</p>
6330
6331<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6332convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6333 -quality 92 passport.jpg
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6334</pre>
6335
6336<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6337 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6338</div>
6339
6340<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6341
6342<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6343 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6344</div>
6345
6346<p class="magick-description">Reverse the order of images in the current image list.</p>
6347
6348
6349<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6350 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6351</div>
6352
6353<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6354
6355<p>A negative <var>x</var> offset rolls the image right-to-left.
6356A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6357
6358
6359<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6360 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6361</div>
6362
6363<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6364
6365<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6366height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6367than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6368the image size is 480x640, the image is not rotated. However, if the image is
6369640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6370<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6371misinterpreted as a file redirection.</p>
6372
6373<p>Empty triangles in the corners, left over from rotating the image, are
6374filled with the <code>background</code> color. </p>
6375
6376<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6377'<code>ScaleRotateTranslate</code>' distort method. </p>
6378
6379
6380<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6381 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6382</div>
6383
6384<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6385
6386<p>Change the image size simply by directly sampling the pixels original
6387from the image. When magnifying, pixels are replicated in blocks. When
6388minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6389over). </p>
6390
6391<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6392a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6393neighbour), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6394avoids all the filter processing of the image. As such it completely ignores
6395the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6396
6397<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6398will be added to the resulting image, though some colors may disappear. </p>
6399
6400<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
6401ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6402
6403
6404<p>The actual sampling point is the middle of the sub-region being sampled.
6405As such a single pixel sampling of an image will take the middle pixel, (or
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6406top-left-middle if image has even dimensions). However the <a href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6407this position some other location within each sub-region being sampled, as
6408a percentage offset.</p>
6409
6410<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6411to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6412separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6413sampling sub-region.</p>
6414
6415
6416<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6417 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6418</div>
6419
6420<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6421
6422<p>This option specifies the sampling factors to be used by the JPEG encoder
6423for chroma downsampling. If this option is omitted, the JPEG library will use
6424its own default values. When reading or writing the YUV format and when
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6425writing the M2V (MPEG-2) format, use <a href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6426downsampling method.</p>
6427
6428<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6429 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6430</div>
6431
6432<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6433
6434<p>Change the image size simply by replacing pixels by averaging pixels
6435together when minifying, or replacing pixels when magnifying. </p>
6436
6437<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6438a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6439faster, as it avoids all the filter processing of the image. As such it
6440completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6441
6442<p>If when shrinking (minifying) images the original image is some integer
6443multiple of the new image size, the number of pixels averaged together to
6444produce the new pixel color is the same across the whole image. This is
6445a special case known as 'binning' and is often used as a method of reducing
6446noise in image such as those generated by digital cameras, especially in low
6447light conditions. </p>
6448
6449
6450<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6451 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6452</div>
6453
6454<p class="magick-description">set scene number.</p>
6455
6456<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6457
6458<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6459 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6460</div>
6461
6462<p class="magick-description">specify the screen to capture.</p>
6463
6464<p>This option indicates that the GetImage request used to obtain the image
6465should be done on the root window, rather than directly on the specified
6466window. In this way, you can obtain pieces of other windows that overlap the
6467specified window, and more importantly, you can capture menus or other popups
6468that are independent windows but appear over the specified window.</p>
6469
6470<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6471 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6472</div>
6473
6474<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6475
6476<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6477 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6478</div>
6479
6480<p class="magick-description">segment the colors of an image.</p>
6481
6482<p>Segment an image by analyzing the histograms of the color components and
6483identifying units that are homogeneous with the fuzzy c-means technique. This
6484is part of the ImageMagick color quantization routines. </p>
6485
6486<p>Specify <var>cluster threshold</var> as the number of pixels in
6487each cluster that must exceed the cluster threshold to be considered valid.
6488<var>Smoothing threshold</var> eliminates noise in the second
6489derivative of the histogram. As the value is increased, you can expect
6490a smoother second derivative. The default is 1.5.</p>
6491
6492<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6493of the color clusters is returned.</p>
6494
6495
6496<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6497 <h3 class="magick-header"><a id="selective-blur"></a>-selective-blur <var>radius</var><br>-selective-blur <var>radius</var>x<var>sigma</var>{<var>+threshold</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6498</div>
6499
6500<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6501
6502<p>Blurs those pixels that are less than or equal to the threshold in
6503contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6504
6505<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6506 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6507</div>
6508
6509<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>
6510
6511<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6512 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>threshold</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6513</div>
6514
6515<p class="magick-description">simulate a sepia-toned photo.</p>
6516
6517<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6518
6519<p>This option applies a special effect to the image, similar to the effect
6520achieved 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
6521toning. A threshold of 80% is a good starting point for a reasonable
6522tone.</p>
6523
6524
6525
6526<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6527 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6528 <h3 class="magick-header">+set <var>key</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6529</div>
6530
6531<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6532
6533<p>This will assign (or modify) specific settings attached to all the images
6534in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6535option will either remove, or reset that setting to a default state, as
6536appropriate. </p>
6537
6538<p>For example, it will modify specific well known image meta-data
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6539'attributes' such as those normally overridden by: the options <a href="command-line-options.html#delay">-delay</a>, <a href="command-line-options.html#dispose">-dispose</a>, and <a href="command-line-options.html#page">-page</a>, <a href="command-line-options.html#colorspace">-colorspace</a>; generally
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6540assigned before the image is read in, by using a <var>key</var> of
6541the same name. </p>
6542
6543<p>If the given <var>key</var> does not match a specific known
6544'attribute ', such as shown above, the setting is stored as a a free form
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6545'property' string. Such settings are listed in <a href="command-line-options.html#verbose">-verbose</a> information ("<code>info:</code>" output format) as "Properties".
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6546</p>
6547
6548<p>This includes string 'properties' that are set by and assigned to images
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6549using the options <a href="command-line-options.html#comment">-comment</a>, <a href="command-line-options.html#label">-label</a>, <a href="command-line-options.html#caption">-caption</a>. These options actually assign
6550a global 'artifact' which are automatically assigned (and any <a href="escape.html">Format Percent
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6551Escapes</a> expanded) to images as they are read in. For example:</p>
6552
6553<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6554-&gt; convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6555identify -format %c rose.png
6556Rose is a rose is a rose is a rose
6557</pre>
6558
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6559<p>The set value can also make use of <a href="escape.html">Format and Print Image
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6560Properties</a> in the defined value. For example:</p>
6561
6562<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6563-&gt; convert rose: -set origsize '%wx%h' -resize 50% \
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6564 -format 'Old size = %[origsize] New size = %wx%h' info:
6565Old size = 70x46 New size = 35x23
6566</pre>
6567
6568<p>Other well known 'properties' that are availible include:
6569'<code>date:create</code>' and '<code>date:modify</code>' and
6570'<code>signature</code>'. </p>
6571
6572<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6573the '<code>page</code>' attribute of an image for images already in memory (also
6574see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6575control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6576option will only provide a direct, unmodified assignment of '<code>page</code>'
6577attribute. </p>
6578
6579<p>This option can also associate a colorspace or profile with your image.
6580For example,</p>
6581
6582<pre>
6583convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6584</pre>
6585
6586<p>Some 'properties' must be defined in a specific way to be used. For
6587example only 'properties' prefixed with "<code>filename:</code>" can be used to
6588modify the output filename of an image. For example</p>
6589
6590<pre>
6591convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6592</pre>
6593
6594<p>If the setting value is prefixed with "<code>option:</code>" the setting will
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6595be saved as a global "Artifact" exactly as if it was set using the <a href="command-line-options.html#define">-define</a> option. As such settings are global in scope, they
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6596can be used to pass 'attributes' and 'properties' of one specific image,
6597in a way that allows you to use them in a completely different image, even if
6598the original image has long since been modified or destroyed. For example: </p>
6599
6600<pre>
6601convert rose: -set option:rosesize '%wx%h' -delete 0 \
6602 label:'%[rosesize]' label_size_of_rose.gif"
6603</pre>
6604
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6605<p>Note that <a href="escape.html">Format Percent Escapes</a> will only match
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6606a 'artifact' if the given <var>key</var> does not match an existing
6607'attribute' or 'property'. </p>
6608
6609<p>You can set the attributes of the image registry by prefixing the value
6610with <code>registry:</code>.</p>
6611
6612<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6613previously-formatted ancillary chunks into the output PNG file, using
6614the commandline option as shown below or by setting the profile via a
6615programming interface:</p>
6616
6617<pre>
6618convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6619</pre>
6620
6621<p>where <var>x</var> is a location flag and
6622<var>filename</var> is a file containing the chunk
6623name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6624This encoder will compute the chunk length and CRC, so those must not
6625be included in the file.</p>
6626
6627<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6628or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6629of the same type, then add a short unique string after the "x" to prevent
6630subsequent profiles from overwriting the preceding ones, e.g.,</p>
6631
6632
6633<pre>
6634convert in.png -set profile PNG-chunk-b01:file01 \
6635 -profile PNG-chunk-b02:file02 out.png
6636</pre>
6637
6638<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6639 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6640</div>
6641
6642<p class="magick-description">shade the image using a distant light source.</p>
6643
6644<p>Specify <var>azimuth</var> and <var>elevation</var> as
6645the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
6646the shading results as a grayscale image.</p>
6647
6648<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6649 <h3 class="magick-header"><a id="shadow"></a>-shadow <var>percent-opacity</var>{x<var>sigma</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6650</div>
6651
6652<p class="magick-description">simulate an image shadow.</p>
6653
6654<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6655 <h3 class="magick-header"><a id="shared-memory"></a>-shared-memory</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6656</div>
6657
6658<p class="magick-description">use shared memory.</p>
6659
6660<p>This option specifies whether the utility should attempt to use shared
6661memory for pixmaps. ImageMagick must be compiled with shared memory support,
6662and the display must support the <var>MIT-SHM</var> extension.
6663Otherwise, this option is ignored. The default is <code>True</code>.</p>
6664
6665<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6666 <h3 class="magick-header"><a id="sharpen"></a>-sharpen <var>radius</var><br>-sharpen <var>radius</var>x<var>sigma</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6667</div>
6668
6669<p class="magick-description">sharpen the image.</p>
6670
6671<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
6672
6673<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6674 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6675</div>
6676
6677<p class="magick-description">Shave pixels from the image edges.</p>
6678
6679<p>The <var>size</var> portion of the <var>geometry</var>
6680argument specifies the width of the region to be removed from both sides of
6681the image and the height of the regions to be removed from top and bottom.
6682Offsets are ignored.</p>
6683
6684<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6685
6686<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6687 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6688</div>
6689
6690<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
6691
6692<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
6693given, the horizontal component of the shear is performed before the vertical
6694component.</p>
6695
6696<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
6697horizontally or vertically, respectively),creating a parallelogram. The amount
6698of each is controlled by the respective shear angle. For horizontal shears,
6699<var>Xdegrees</var> is measured clockwise relative to "up" (the
6700negative y-axis), sliding the top edge to the right when 0°&lt;<var>Xdegrees</var>&lt;90° and to the left when 90°&lt;<var>Xdegrees</var>&lt;180°. For vertical shears <var>Ydegrees</var> is measured clockwise relative to "right" (the
6701positive x-axis), sliding the right edge down when 0°&lt;<var>Ydegrees</var>&lt;90° and up when 90°&lt;<var>Ydegrees</var>&lt;180°.</p>
6702
6703<p>Empty triangles left over from shearing the image are filled with the color
6704defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
6705using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
6706
6707<p>The horizontal shear is performed before the vertical part. This is
6708important to note, since horizontal and vertical shears do not
6709<var>commute</var>, i.e., the order matters in a sequence of shears. For
6710example, the following two commands are not equivalent.</p>
6711
6712<pre>
6713convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
6714convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
6715</pre>
6716
6717<p>The first of the two commands above is equivalent to the following, except
6718for the amount of empty space created; the command that follows generates
6719a smaller image, and so is a better choice in terms of time and space.</p>
6720
6721<pre>
6722convert logo: -shear 20x60 logo-sheared.png
6723</pre>
6724
6725<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6726 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6727</div>
6728
6729<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
6730
6731<p>Increase the contrast of the image using a sigmoidal transfer function
6732without saturating highlights or shadows. <var>Contrast</var>
6733indicates how much to increase the contrast. For example, 0 is none, 3 is
6734typical and 20 is a lot.
6735</p>
6736
6737<p>The <var>mid-point</var> indicates where the maximum change
6738'slope' in contrast should fall in the resultant image (0 is white; 50% is
6739middle-gray; 100% is black). </p>
6740
6741<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
6742
6743<p>To achieve the equivalent of a sigmoidal brightness change (similar to
6744a gamma adjustment), you would use <var>-sigmoidal-contrast
6745{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
6746Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
6747
6748<p>Using a very high <var>contrast</var> will produce a sort of
6749'smoothed thresholding' of the image. Not as sharp (with high aliasing
6750effects) of a true threshold, but with tapered gray-levels around the threshold
6751<var>mid-point</var>. </p>
6752
6753<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6754 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6755</div>
6756
6757<p class="magick-description">operate silently.</p>
6758
6759<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6760 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6761</div>
6762
6763<p class="magick-description">minimum RMSE for subimage match.</p>
6764
6765<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>
6766
6767<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6768 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6769</div>
6770
6771<p class="magick-description">set the width and height of the image.</p>
6772
6773<p>Use this option to specify the width and height of raw images whose
6774dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6775<code>CMYK</code>. In addition to width and height, use <a href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6776image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
6777640x512+256).</p>
6778
6779<p>For Photo CD images, choose from these sizes:</p>
6780
6781<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6782192x128
6783384x256
6784768x512
67851536x1024
67863072x2048
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6787</pre>
6788
6789<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6790 <h3 class="magick-header"><a id="sketch"></a>-sketch <var>radius</var><br>-sketch <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6791</div>
6792
6793<p class="magick-description">simulate a pencil sketch.</p>
6794
6795<p>Sketch with the given radius, standard deviation (sigma), and angle. The
6796angle given is the angle toward which the image is sketched. That is the
6797direction people would consider the object is coming from. </p>
6798
6799<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6800 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6801</div>
6802
6803<p class="magick-description">smush an image sequence together.</p>
6804
6805<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6806 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6807</div>
6808
6809<p class="magick-description">Set the number of screen snapshots.</p>
6810
6811<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
6812
6813<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6814 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>threshold</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6815</div>
6816
6817<p class="magick-description">negate all pixels above the threshold level.</p>
6818
6819<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6820
6821<p>This option produces a <var>solarization</var> effect seen when
6822exposing a photographic film to light during the development process.</p>
6823
6824<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6825 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6826</div>
6827
6828<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>
6829
6830
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6831<dl class="dl-horizontal">
6832 <dt>barycentric</dt>
6833 <dd>three point triangle of color given 3 points.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6834 Giving only 2 points will form a linear gradient between those points.
6835 The gradient generated extends beyond the triangle created by those
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6836 3 points. </dd>
6837 <dt>bilinear</dt>
6838 <dd>Like barycentric but for 4 points. Less than 4 points
6839 fall back to barycentric. </dd>
6840 <dt>voronoi</dt>
6841 <dd>Simply map each pixel to the to nearest color point
6842 given. The result are polygonal 'cells' of solid color. </dd>
6843 <dt>shepards</dt>
6844 <dd>Colors points biased on the ratio of inverse distance
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6845 squared. Generating spots of color in a sea of the average of
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6846 colors. </dd>
6847 <dt>inverse</dt>
6848 <dd>Colors points biased on the ratio of inverse distance.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6849 This generates sharper points of color rather than rounded spots of
6850 '<code>shepards</code>' Generating spots of color in a sea of the
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6851 average of colors. </dd>
6852</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6853
6854<p>The points are placed according to the images location on the virtual
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6855canvas (<a href="command-line-options.html#page">-page</a> or <a href="command-line-options.html#repage">-repage</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6856offset), and do not actually have to exist on the given image, but may be
6857some point beyond the edge of the image. All points are floating point values.
6858</p>
6859
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6860<p>Only the color channels defined by the <a href="command-line-options.html#channel">-channel</a> are
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6861modified, which means that by default matte/alpha transparency channel is not
6862effected. Typically transparency channel is turned off either before or after
6863the operation. </p>
6864
6865<p>Of course if some color points are transparent to generate a transparent
6866gradient, then the image also requires transparency enabled to store the
6867values. </p>
6868
6869<p>All the above methods when given a single point of color will replace all
6870the colors in the image with the color given, regardless of the point. This is
6871logical, and provides an alternative technique to recolor an image to some
6872default value. </p>
6873
6874
6875<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6876 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6877</div>
6878
6879<p class="magick-description">Splice the current background color into the image.</p>
6880
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6881<p>This will add rows and columns of the current <a href="command-line-options.html#background">-background</a> color into the given image according to the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6882given <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
6883image into four quadrants, separating them by the inserted rows and columns.
6884</p>
6885
6886<p>If a dimension of geometry is zero no rows or columns will be added for that
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6887dimension. Similarly using a zero offset with the appropriate <a href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
6888the image, padding the image only along that one edge. Edge padding is what <a href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6889
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6890<p>If the exact same <var>geometry</var> and <a href="command-line-options.html#gravity">-gravity</a> is later used with <a href="command-line-options.html#chop">-chop</a> the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6891added added all splices removed. </p>
6892
6893<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6894 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6895</div>
6896
6897<p class="magick-description">displace image pixels by a random amount.</p>
6898
6899<p>The argument <var>amount</var> defines the size of the
6900neighborhood around each pixel from which to choose a candidate pixel to
6901swap.</p>
6902
6903<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6904 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6905</div>
6906
6907<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
6908
6909<p>Choose from these statistic types:</p>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6910<dl class="dl-horizontal">
6911<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
6912<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
6913<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
6914<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
6915<dt>Median</dt><dd>median value per channel in neighborhood</dd>
6916<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
6917<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
6918<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
6919<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
6920</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6921
6922<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6923 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6924</div>
6925
6926<p class="magick-description">hide watermark within an image.</p>
6927
6928<p>Use an offset to start the image hiding some number of pixels from the
6929beginning of the image. Note this offset and the image size. You will need
6930this information to recover the steganographic image (e.g. display -size
6931320x256+35 stegano:image.png).</p>
6932
6933<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6934 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6935</div>
6936
6937<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
6938
6939<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>
6940
6941<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6942 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6943</div>
6944
6945<p class="magick-description">pixel storage type. Here are the valid types:</p>
6946
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]6947<dl class="dl-horizontal">
6948<dt>char</dt><dd>unsigned characters</dd>
6949<dt>double</dt><dd>doubles</dd>
6950<dt>float</dt><dd>floats</dd>
6951<dt>integer</dt><dd>integers</dd>
6952<dt>long</dt><dd>longs</dd>
6953<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
6954<dt>short</dt><dd>unsigned shorts</dd>
6955</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6956
6957<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
6958values range from 0 to the maximum value the storage type can support.</p>
6959
6960<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6961 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6962</div>
6963
6964<p class="magick-description">Set a type of stretch style for fonts.</p>
6965
6966<p>This setting suggests a type of stretch that ImageMagick should try to
6967apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
6968
6969<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6970Any
6971Condensed
6972Expanded
6973ExtraCondensed
6974ExtraExpanded
6975Normal
6976SemiCondensed
6977SemiExpanded
6978UltraCondensed
6979UltraExpanded
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6980</pre>
6981
6982<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
6983stretch</a>.</p>
6984
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]6985<p>For other settings that affect fonts, see the options <a href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6986
6987<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6988 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6989</div>
6990
6991<p class="magick-description">strip the image of any profiles or comments.</p>
6992
6993<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]6994 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6995</div>
6996
6997<p class="magick-description">color to use when stroking a graphic primitive.</p>
6998
6999<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7000
7001<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7002
7003<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7004 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7005</div>
7006
7007<p class="magick-description">set the stroke width.</p>
7008
7009<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7010
7011<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7012 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7013</div>
7014
7015<p class="magick-description">Set a font style for text.</p>
7016
7017<p>This setting suggests a font style that ImageMagick should try to apply to
7018the currently selected font family. Select <var>fontStyle</var> from
7019the following.</p>
7020
7021<pre>
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7022Any
7023Italic
7024Normal
7025Oblique
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7026</pre>
7027
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7028<p>For other settings that affect fonts, see the options <a href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7029
7030<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7031 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7032</div>
7033
7034<p class="magick-description">search for subimage.</p>
7035
7036<p>This option is required to have compare search for the best match location
7037of a small image within a larger image. This search will produce two images
7038(or two frames). The first is the "difference" image and the second will
7039be the "match score" image.</p>
7040
7041<p>The "match-score" image is smaller containing a pixel for ever possible
7042position of the top-left corner of the given sub-image. that is its size will
7043be the size of the larger_image - sub_image + 1. The brightest location in
7044this image is the location s the locate on the best match that is also
7045reported. Note that this may or may not be a perfect match, and the actual
7046brightness will reflect this. Other bright 'peaks' can be used to locate other
7047possible matching locations. </p>
7048
7049<p>Note that the search will try to compare the sub-image at every possible
7050location in the larger image, as such it can be very slow. The smaller the
7051sub-image the faster this search is. </p>
7052
7053
7054<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7055 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7056</div>
7057
7058<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7059
7060<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7061images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7062the last two images in the sequence.</p>
7063
7064<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7065 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7066</div>
7067
7068<p class="magick-description">swirl image pixels about the center.</p>
7069
7070<p><var>Degrees</var> defines the tightness of the swirl.</p>
7071
7072<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7073 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7074</div>
7075
7076<p class="magick-description">synchronize image to storage device.</p>
7077
7078<p>Set to "true" to ensure all image data is fully flushed and synchronized
7079to disk. There is a performance penalty, but the benefits include ensuring a
7080valid image file in the event of a system crash and early reporting if there
7081is not enough disk space for the image pixel cache.</p>
7082
7083<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7084 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7085</div>
7086
7087<p class="magick-description">Mark the image as modified.</p>
7088
7089<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7090 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7091</div>
7092
7093<p class="magick-description">font for writing fixed-width text.</p>
7094
7095<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7096formatted text. The default is 14 point <var>Courier</var>.</p>
7097
7098<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7099OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7100<code>x:fixed</code> is OPTION1.</p>
7101
7102<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7103 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7104</div>
7105
7106<p class="magick-description">name of texture to tile onto the image background.</p>
7107
7108<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7109 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7110</div>
7111
7112<!-- {<var>green,blue,opacity</var>}
7113<p>If the green or blue value is omitted, these channels use the same value as
7114the first one provided. If all three color values are the same, the result is
7115a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7116and any partially transparent pixel becomes fully transparent.</p>
7117-->
7118
7119<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7120
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7121<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
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7122maximum channel value, while all other values are assigned the minimum.</p>
7123
7124<p> The threshold value can be given as a percentage or as an absolute integer
7125value corresponding to the desired channel value. When given as an integer,
7126the minimum attainable value is 0 (corresponding to black when all channels
7127are affected), but the maximum value (corresponding to white) is that of the
7128<code>quantum depth</code> of the particular build of ImageMagick, and is
7129therefore dependent on the installation. For that reason, a reasonable
7130recommendation for most applications is to specify the threshold values as
7131a percentage. </p>
7132
7133<p> The following would force pixels with red values above 50% to have 100%
7134red values, while those at or below 50% red would be set to 0 in the red
7135channel. The green, blue, and alpha channels (if present) would be unchanged.
7136</p>
7137
7138<pre>
7139convert in.png -channel red -threshold 50% out.png
7140</pre>
7141
7142<p>As (possibly) impractical but instructive examples, the following would
7143generate an all-black and an all-white image with the same dimensions as the
7144input image.</p>
7145
7146
7147<pre>
7148convert in.png -threshold 100% black.png
7149convert in.png -threshold -1 white.png
7150</pre>
7151
7152<p>Note that the values of the transparency channel is treated as 'matte'
7153values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7154
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7155<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>.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7156</p>
7157
7158<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7159 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7160</div>
7161
7162<p class="magick-description">Create a thumbnail of the image.</p>
7163
7164<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7165for speed and any image profile, other than a color profile, is removed to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7166reduce the thumbnail size. To strip the color profiles as well, add <a href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7167
7168<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7169
7170<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7171 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7172</div>
7173
7174<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7175
7176<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7177 <h3 class="magick-header">-tile <var>geometry</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7178</div>
7179
7180<p class="magick-description">Specify the layout of images.</p>
7181
7182<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7183
7184<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7185 <h3 class="magick-header">-tile</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7186</div>
7187
7188<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7189
7190<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7191 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7192</div>
7193
7194<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7195
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7196<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile">-tile</a> or <a href="command-line-options.html#texture">-texture</a>, or directly applied for
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7197creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7198formats. </p>
7199
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7200<p>Internally ImageMagick does a <a href="command-line-options.html#roll">-roll</a> of the tile image
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7201by the arguments given when the tile image is set. </p>
7202
7203<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7204 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7205</div>
7206
7207<p class="magick-description">Tint the image with the fill color.</p>
7208
7209<p>Tint the image with the fill color.</p>
7210
7211<p>Specify the amount of tinting as a percentage. Pure colors like black,
7212white red, yellow, will not be affected by -tint. Only mid-range colors such
7213as the various shades of grey.</p>
7214
7215<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7216 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7217</div>
7218
7219<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7220
7221<p>Use this option to assign a specific title to the image. This assigned to
7222the image window and is typically displayed in the window title bar.
7223Optionally you can include the image filename, type, width, height, Exif data,
7224or other image attribute by embedding special format characters described
7225under the <a href="command-line-options.html#format">-format</a> option.</p>
7226
7227<p>For example,</p>
7228
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7229<pre>
7230-title "%m:%f %wx%h"
7231</pre>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7232
7233<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7234titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7235
7236
7237<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7238 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7239</div>
7240
7241<p class="magick-description">transform the image.</p>
7242
7243<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7244
7245<pre>
7246convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7247</pre>
7248
7249
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7250<p>This operator has been now been superseded by the <a href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7251
7252
7253<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7254 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7255</div>
7256
7257<p class="magick-description">Make this color transparent within the image.</p>
7258
7259<p>The <var>color</var> argument is defined using the format
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7260described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz">-fuzz</a> setting can be used to match and replace colors similar to the one
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7261given. </p>
7262
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7263<p>Use <a href="command-line-options.html#transparent">+transparent</a> to invert the pixels matched.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7264that is make all non-matching colors transparent. </p>
7265
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7266<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a href="command-line-options.html#transparent">-transparent</a> but replaces the matching color with the
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7267current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7268However the <a href="command-line-options.html#transparent">-transparent</a> operator also ensures
7269that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha">-alpha</a> set</code>", and does not require you to modify the <a href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7270
7271<p>Note that this does not define the color as being the 'transparency color'
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7272used for color-mapped image formats, such as GIF. For that use <a href="command-line-options.html#transparent-color">-transparent-color</a> </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7273
7274
7275<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7276 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7277</div>
7278
7279<p class="magick-description">Set the transparent color.</p>
7280
7281<p>Sometimes this is used for saving to image formats such as
7282GIF and PNG8 which uses this color to represent boolean transparency. This
7283does not make a color transparent, it only defines what color the transparent
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7284color is in the color palette of the saved image. Use <a href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7285
7286<p>This option allows you to have both an opaque visible color, as well as a
7287transparent color of the same color value without conflict. That is, you can
7288use the same color for both the transparent and opaque color areas within an
7289image. This, in turn, frees to you to select a transparent color that is
7290appropriate when an image is displayed by an application that does not handle a
7291transparent color index, while allowing ImageMagick to correctly handle images of this
7292type. </p>
7293
7294<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7295
7296<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7297 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7298</div>
7299
7300<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7301
7302<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7303</p>
7304
7305<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7306 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7307</div>
7308
7309<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>
7310
7311
7312<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7313 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7314</div>
7315
7316<p class="magick-description">tree depth for the color reduction algorithm.</p>
7317
7318<p>Normally, this integer value is zero or one. A value of zero or one causes
7319the use of an optimal tree depth for the color reduction algorithm.</p>
7320
7321<p>An optimal depth generally allows the best representation of the source
7322image with the fastest computational speed and the least amount of memory.
7323However, the default depth is inappropriate for some images. To assure the
7324best representation, try values between 2 and 8 for this parameter. Refer to
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7325the <a href="quantize.html">color reduction algorithm</a> for more details.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7326
7327<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7328option, or writing to an image format which requires color reduction, is
7329required for this option to take effect.</p>
7330
7331<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7332 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7333</div>
7334
7335<p class="magick-description">trim an image.</p>
7336
7337<p>This option removes any edges that are exactly the same color as the corner
7338pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7339edges that are nearly the same color as the corner pixels.</p>
7340
7341<p>The page or virtual canvas information of the image is preserved allowing
7342you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7343image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7344information if it is unwanted.</p>
7345
7346<p>If the trimmed image 'disappears' an warning is produced, and a special
7347single pixel transparent 'missed' image is returned, in the same way as when a
7348<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7349
7350
7351<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7352 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7353</div>
7354
7355<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7356<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7357<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7358<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7359
7360<p>Normally, when a format supports different subformats such as grayscale and
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7361truecolor, the encoder will try to choose an efficient subformat. The <a href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7362example, to prevent a JPEG from being written in grayscale format even though
7363only gray pixels are present, use.</p>
7364
7365<pre>
7366convert bird.png -type TrueColor bird.jpg
7367</pre>
7368
7369<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7370encoder to write an alpha channel even though the image is opaque, if the
7371output format supports transparency.</p>
7372
7373<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>
7374
7375<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7376 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7377</div>
7378
7379<p class="magick-description">set the color of the annotation bounding box.</p>
7380
7381<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7382
7383<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7384
7385
7386<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7387 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7388</div>
7389
7390<p class="magick-description">detect when image file is modified and redisplay.</p>
7391
7392<p>Suppose that while you are displaying an image the file that is currently
7393displayed is over-written. <code>display</code> will automagically detect that
7394the input file has been changed and update the displayed image
7395accordingly.</p>
7396
7397
7398<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7399 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7400</div>
7401
7402<p class="magick-description">discard all but one of any pixel color.</p>
7403
7404
7405<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7406 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7407</div>
7408
7409<p class="magick-description">the units of image resolution.</p>
7410
7411<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7412<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7413with the <a href="command-line-options.html#density">-density</a> option.</p>
7414
7415
7416<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7417 <h3 class="magick-header"><a id="unsharp"></a>-unsharp <var>radius</var><br>-unsharp <var>radius</var>x<var>sigma</var>{<var>+gain</var>}{<var>+threshold</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7418</div>
7419
7420<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7421
7422<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7423convolved with a Gaussian operator of the given radius and standard deviation
7424(sigma). For reasonable results, radius should be larger than sigma. Use
7425a radius of 0 to have the method select a suitable radius.</p>
7426
7427<p>The parameters are:</p>
7428
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]7429<dl class="dl-horizontal">
7430<dt>radius</dt>
7431<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7432<dt>sigma</dt>
7433<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7434<dt>gain</dt>
7435<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7436<dt>threshold</dt>
7437<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7438</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7439
7440<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7441 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7442</div>
7443
7444<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>
7445
7446
7447<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7448 <h3 class="magick-header"><a id="version"></a>-version</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7449</div>
7450
7451<p class="magick-description">print ImageMagick version string and exit.</p>
7452
7453
7454<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7455 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7456</div>
7457
7458<p class="magick-description">FlashPix viewing parameters.</p>
7459
7460
7461<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7462 <h3 class="magick-header"><a id="vignette"></a>-vignette <var>radius</var>{x<var>sigma</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7463</div>
7464
7465<p class="magick-description">soften the edges of the image in vignette style.</p>
7466
7467<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>
7468
7469<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7470 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7471</div>
7472
7473<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7474
7475<p>This option defines what color source should be used if and when a color
7476lookup completely 'misses' the source image. The color(s) that appear to
7477surround the source image. Generally this color is derived from the source
7478image, but could also be set to a specify background color. </p>
7479
7480<p>Choose from these methods:</p>
7481
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7482<dl class="dl-horizontal">
7483<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7484<dt>black</dt><dd>the area surrounding the image is black</dd>
7485<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7486<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7487<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7488<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7489<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7490<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7491<dt>mirror</dt><dd>mirror tile the image</dd>
7492<dt>random</dt><dd>choose a random pixel from the image</dd>
7493<dt>tile</dt><dd>tile the image (default)</dd>
7494<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7495<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7496<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7497<dt>white</dt><dd>the area surrounding the image is white</dd>
7498</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7499
7500<p>The default value is "edge".</p>
7501
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7502<p>This most important for distortion operators such as <a href="command-line-options.html#distort">-distort</a>, <a href="command-line-options.html#implode">-implode</a>, and <a href="command-line-options.html#fx">-fx</a>.
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7503However it also effects operations that may access pixels just outside the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7504image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7505
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7506<p>To print a complete list of virtual pixel types, use the <a href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7507
7508
7509<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7510 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7511</div>
7512
7513<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7514
7515<p>Choose from these visual classes:</p>
7516
7517<pre>
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]7518StaticGray TrueColor
7519GrayScale DirectColor
7520StaticColor default
7521PseudoColor visual id
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7522</pre>
7523
7524<p>The X server must support the visual you choose, otherwise an error occurs.
7525If a visual is not specified, the visual class that can display the most
7526simultaneous colors on the default screen is chosen.</p>
7527
7528
7529<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7530 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7531</div>
7532
7533<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7534
7535<p>Take a grayscale image (with alpha mask) and modify the destination image's
7536brightness according to watermark image's grayscale value and the
7537<var>brightness</var> percentage. The destinations color saturation
7538attribute is just direct modified by the <var>saturation</var>
7539percentage, which defaults to 100 percent (no color change). </p>
7540
7541
7542<div style="margin: auto;">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7543 <h3 class="magick-header"><a id="wave"></a>-wave <var>amplitude</var><br>-wave <var>amplitude</var>x<var>wavelength</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7544</div>
7545
7546<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7547
7548<p>Specify <var>amplitude</var> and <var>wavelength</var>
7549of the wave.</p>
7550
7551<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7552 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7553</div>
7554
7555<p class="magick-description">Set a font weight for text.</p>
7556
7557<p>This setting suggests a font weight that ImageMagick should try to apply to
7558the currently selected font family. Use a positive integer for
7559<var>fontWeight</var> or select from the following.</p>
7560
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]7561<dl class="dl-horizontal">
7562<dt>All </dt>
7563<dd>No effect. </dd>
7564<dt>Bold </dt>
7565<dd>Same as <var>fontWeight</var> = 700.</dd>
7566<dt>Bolder </dt>
7567<dd>Add 100 to font weight if currently ≤ 800.</dd>
7568<dt>Lighter </dt>
7569<dd>Subtract 100 to font weight if currently ≤ 100.</dd>
7570<dt>Normal </dt>
7571<dd>Same as <var>fontWeight</var> = 400.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7572
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]7573<br>
7574
7575<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7576
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7577<p>For other settings that affect fonts, see the options <a href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7578
7579<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7580 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7581</div>
7582
7583<p class="magick-description">chromaticity white point.</p>
7584
7585<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7586 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7587</div>
7588
7589<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7590
7591<p> The threshold value can be given as a percentage or as an absolute integer
7592value within [0, <var>QuantumRange</var>] corresponding to the
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7593desired <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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7594
7595<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7596 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7597</div>
7598
7599<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7600
7601<p><var>id</var> can be a window id or name. Specify <code>root</code>
7602to select X's root window as the target window.</p>
7603
7604<p>By default the image is tiled onto the background of the target window. If
7605<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
7606image is surrounded by the background color. Refer to <code>X RESOURCES</code>
7607for details.</p>
7608
7609<p>The image will not display on the root window if the image has more unique
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]7610colors than the target window colormap allows. Use <a href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7611
7612<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7613 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7614</div>
7615
7616<p class="magick-description">specify the window group.</p>
7617
7618<div style="margin: auto;">
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]7619 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7620</div>
7621
7622<p class="magick-description">write an image sequence.</p>
7623
7624<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>
7625
7626<p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]7627
7628<div style="margin: auto;">
7629 <h3 class="magick-header"><a id="write-mask"></a>-write-mask <var>filename</var></h3>
7630</div>
7631
7632<p class="magick-description">prevent pixels from being written.</p>
7633
7634<p>Use <a href="command-line-options.html#read-mask">+write-mask</a> to remove the mask from images.</p>
7635
cristyb2cad532015-05-16 13:02:45 +0000[diff] [blame]7636</dl></div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7637</div>
7638 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]7639 <p><a href="support.html">Donate</a> •
7640 <a href="sitemap.html">Sitemap</a> •
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7641 <a href="links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]7642 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7643</p>
7644 <p><a href="command-line-options.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]7645 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]7646 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]7647 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7648 </footer>
7649</div><!-- /.container -->
7650
7651 <script src="https://localhost/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]7652 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]7653</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]7654</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]7655</html>