Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 851dbceb0a51cbcd3ed512f074e9f2d797b7cbc1 / . / www / api / distort.html
blob: fc0959362148824cd75bb448ed8c682e19351528 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Image Distortions</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, image, distortions, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame^]127 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy69e3f922010-04-10 14:20:03 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]143</div>
cristy0d909f12010-06-16 13:12:19 +0000[diff] [blame]144<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame^]145 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy0d909f12010-06-16 13:12:19 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]149</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]150
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]151<div class="eastbar">
152 <script type="text/javascript">
153 <!--
154 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]155 google_ad_slot = "0574824969";
156 google_ad_width = 160;
157 google_ad_height = 600;
158 //-->
159 </script>
160 <script type="text/javascript"
161 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
162 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]163</div>
164
165<div class="main">
166
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]167<p class="navigation-index">[<a href="#DistortImage">DistortImage</a> &bull; <a href="#SparseColorImage">SparseColorImage</a>]</p>
168
169<h2><a href="http://www.imagemagick.org/api/MagickCore/distort
170_8c.html" target="source" name="DistortImage">DistortImage</a></h2>
171<div class="doc-section">
172
173<p>DistortImage() distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usally of the same size as the source image, unless 'bestfit' is set to true.</p></ol>
174
175<p>If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping.</p></ol>
176
177<p>If the '-verbose' control option has been set print to standard error the equicelent '-fx' formula with coefficients for the function, if practical.</p></ol>
178
179<p>The format of the DistortImage() method is:</p>
180
181<pre class="code">
182 Image *DistortImage(const Image *image,const DistortImageMethod method,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]183 const size_t number_arguments,const double *arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184 MagickBooleanType bestfit, ExceptionInfo *exception)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>image</h5>
190<ol><p>the image to be distorted.</p></ol>
191
192<h5>method</h5>
193<ol><p>the method of image distortion.</p></ol>
194
195<p>ArcDistortion always ignores source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.</p></ol>
196
197<p>Affine, Perspective, and Bilinear, do least squares fitting of the distrotion when more than the minimum number of control point pairs are provided.</p></ol>
198
199<p>Perspective, and Bilinear, fall back to a Affine distortion when less than 4 control point pairs are provided. While Affine distortions let you use any number of control point pairs, that is Zero pairs is a No-Op (viewport only) distortion, one pair is a translation and two pairs of control points do a scale-rotate-translate, without any shearing.</p></ol>
200
201<h5>number_arguments</h5>
202<ol><p>the number of arguments given.</p></ol>
203
204<h5>arguments</h5>
205<ol><p>an array of floating point arguments for this method.</p></ol>
206
207<h5>bestfit</h5>
208<ol><p>Attempt to 'bestfit' the size of the resulting image. This also forces the resulting image to be a 'layered' virtual canvas image. Can be overridden using 'distort:viewport' setting.</p></ol>
209
210<h5>exception</h5>
211<ol><p>return any errors or warnings in this structure</p></ol>
212
213<p>Extra Controls from Image meta-data (artifacts)...</p></ol>
214
215<p>o "verbose" Output to stderr alternatives, internal coefficents, and FX equivelents for the distortion operation (if feasible). This forms an extra check of the distortion method, and allows users access to the internal constants IM calculates for the distortion.</p></ol>
216
217<p>o "distort:viewport" Directly set the output image canvas area and offest to use for the resulting image, rather than use the original images canvas, or a calculated 'bestfit' canvas.</p></ol>
218
219<p>o "distort:scale" Scale the size of the output canvas by this amount to provide a method of Zooming, and for super-sampling the results.</p></ol>
220
221<p>Other settings that can effect results include</p></ol>
222
223<p>o 'interpolate' For source image lookups (scale enlargements)</p></ol>
224
225<p>o 'filter' Set filter to use for area-resampling (scale shrinking). Set to 'point' to turn off and use 'interpolate' lookup instead</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/distort
229_8c.html" target="source" name="SparseColorImage">SparseColorImage</a></h2>
230<div class="doc-section">
231
232<p>SparseColorImage(), given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.</p></ol>
233
234<p>The format of the SparseColorImage() method is:</p>
235
236<pre class="code">
237 Image *SparseColorImage(const Image *image,const ChannelType channel,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]238 const SparseColorMethod method,const size_t number_arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]239 const double *arguments,ExceptionInfo *exception)
240</pre>
241
242<p>A description of each parameter follows:</p></ol>
243
244<h5>image</h5>
245<ol><p>the image to be filled in.</p></ol>
246
247<h5>channel</h5>
248<ol><p>Specify which color values (in RGBKA sequence) are being set. This also determines the number of color_values in above.</p></ol>
249
250<h5>method</h5>
251<ol><p>the method to fill in the gradient between the control points.</p></ol>
252
253<p>The methods used for SparseColor() are often simular to methods used for DistortImage(), and even share the same code for determination of the function coefficents, though with more dimensions (or resulting values).</p></ol>
254
255<h5>number_arguments</h5>
256<ol><p>the number of arguments given.</p></ol>
257
258<h5>arguments</h5>
259<ol><p>array of floating point arguments for this method-- x,y,color_values-- with color_values given as normalized values.</p></ol>
260
261<h5>exception</h5>
262<ol><p>return any errors or warnings in this structure</p></ol>
263
264 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]265
266</div>
267
268<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]269 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]270 <span id="linkbar-center">
271 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]272 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]273 </span>
274 <span id="linkbar-east">&nbsp;</span>
275 </div>
276 <div class="footer">
277 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
278 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
279 </div>
280 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]281 <script type="text/javascript">
282 var _gaq = _gaq || [];
283 _gaq.push(['_setAccount', 'UA-17690367-1']);
284 _gaq.push(['_trackPageview']);
285
286 (function() {
287 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
288 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
289 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
290 })();
291 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]292</body>
293</html>