File: transform.html

package info (click to toggle)
imagemagick 7%3A6.2.4.5.dfsg1-0.15%2Betch1
  • links: PTS
  • area: main
  • in suites: etch
  • size: 29,972 kB
  • ctags: 13,707
  • sloc: ansic: 202,656; cpp: 17,315; sh: 10,363; xml: 5,523; perl: 4,486; makefile: 3,148; tcl: 459
file content (409 lines) | stat: -rw-r--r-- 15,003 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <style type="text/css"><!--
    @import url("../../www/magick.css");
  //--></style>
  <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
  <meta http-equiv="Content-Language" content="en-US" />
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org" />
  <meta name="Generator" content="PHP" />
  <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, PerlMagick, Magick++, Image, Magick" />
  <meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated.  ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems.  Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically.  ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF." />
  <meta name="Rating" content="GENERAL" />
  <meta name="Robots" content="ALL" />
  <meta name="Generator" content="ImageMagick Studio LLC" />
  <meta name="Author" content="ImageMagick Studio LLC" />
  <meta name="Revisit-after" content="2 DAYS" />
  <meta name="Resource-type" content="document" />
  <meta name="Copyright" content="Copyright (c) 1999-2005 ImageMagick Studio LLC" />
  <meta name="Distribution" content="Global" />
  <link rel="shortcut icon" href="/../images/wand.ico"  type="image/x-icon" />
</head>

<body id="www-imagemagick-org">
  <table width="100%" id="titlebar" bgcolor="#f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
    <tbody>
      <tr valign="top">
        <td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="202" height="118" border="0" name="titlebar-west" /></a></td>
        <td width="35%"><br /></td>
        <td align="left"><a href="http://www.imagemagick.org/" target="1525079611"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
        <td width="65%"><br /></td>
        <td bgcolor="white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
        <td bgcolor="white" align="right"><a href="../../index.html"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
      </tr>
    </tbody>
  </table>

  <table width="100%" border="0" cellpadding="0" cellspacing="0" summary="">
  <tbody>

    <tr valign="top" style="height: 100%;">
      <td id="menu" width="1%" height="100%">
      <p><a href="#main">Skip to page contents</a></p>
      <span>[</span>
      <a href="../../index.html">About ImageMagick</a>
      <a href="../../www/command-line-tools.html">Command-line Tools</a>
      <a href="../../www/api.html">Program Interfaces</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/install-source.html">Install from Source</a>
      <a href="../../www/binary-releases.html">Binary Releases</a>
      <a href="../../www/resources.html">Resources</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/download.html">Download</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/links.html">Links</a>
  <span>]</span><br /><br /><span>[</span>
      <a href="../../www/sponsors.html">Sponsors</a>
  <a href="http://www.travelsur.net/" class="sponsor" target="sponsor">Trips to Argentina</a><!-- 20050621 -->
      <span>]</span>
      </td>

      <td id="main" valign="top">
<p class="navigation-index">[ <a href="#Chop">Chop</a> | <a href="#CoalesceImages">CoalesceImages</a> | <a href="#CropImage">CropImage</a> | <a href="#DeconstructImages">DeconstructImages</a> | <a href="#FlattenImage">FlattenImage</a> | <a href="#FlipImage">FlipImage</a> | <a href="#FlopImage">FlopImage</a> | <a href="#MosaicImages">MosaicImages</a> | <a href="#RollImage">RollImage</a> | <a href="#ShaveImage">ShaveImage</a> | <a href="#SpliceImage">SpliceImage</a> | <a href="#TransformImage">TransformImage</a> | <a href="#TransformImages">TransformImages</a> | <a href="#TrimImage">TrimImage</a> ]</p>

<div style="margin: auto;">
  <h2><a name="Chop">Chop</a></h2>
</div>

<p>Chop() removes a region of an image and collapses the image to occupy the removed portion.</p>

<p>The format of the ChopImage method is:</p>

<pre class="code">
  Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>chop_info</h4>
<p>Define the region of the image to chop.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="CoalesceImages">CoalesceImages</a></h2>
</div>

<p>CoalesceImages() composites a set of images while respecting any page offsets and disposal methods.  GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset.  CoalesceImages() returns a new sequence where each image in the sequence is the same size as the first and composited with the next image in the sequence.</p>

<p>The format of the CoalesceImages method is:</p>

<pre class="code">
  Image *CoalesceImages(Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image sequence.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="CropImage">CropImage</a></h2>
</div>

<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p>

<p>The format of the CropImage method is:</p>

<pre class="code">
  Image *CropImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>geometry</h4>
<p>Define the region of the image to crop with members x, y, width, and height.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="DeconstructImages">DeconstructImages</a></h2>
</div>

<p>DeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p>

<p>The format of the DeconstructImages method is:</p>

<pre class="code">
  Image *DeconstructImages(const Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="FlattenImage">FlattenImage</a></h2>
</div>

<p>FlattenImage() merges a sequence of images.  This is useful for combining Photoshop layers into a single image.</p>

<p>The format of the FlattenImage method is:</p>

<pre class="code">
  Image *FlattenImage(Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image sequence.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="FlipImage">FlipImage</a></h2>
</div>

<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>

<p>The format of the FlipImage method is:</p>

<pre class="code">
  Image *FlipImage(const Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="FlopImage">FlopImage</a></h2>
</div>

<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>

<p>The format of the FlopImage method is:</p>

<pre class="code">
  Image *FlopImage(const Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="MosaicImages">MosaicImages</a></h2>
</div>

<p>MosaicImages() inlays an image sequence to form a single coherent picture. It returns a single image with each image in the sequence composited at the location defined by the page member of the image structure.</p>

<p>The format of the MosaicImage method is:</p>

<pre class="code">
  Image *MosaicImages(const Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="RollImage">RollImage</a></h2>
</div>

<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>

<p>The format of the RollImage method is:</p>

<pre class="code">
  Image *RollImage(const Image *image,const long x_offset,
    const long y_offset,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>x_offset</h4>
<p>The number of columns to roll in the horizontal direction.</p>

<h4>y_offset</h4>
<p>The number of rows to roll in the vertical direction.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="ShaveImage">ShaveImage</a></h2>
</div>

<p>ShaveImage() shaves pixels from the image edges.  It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>

<p>The format of the ShaveImage method is:</p>

<pre class="code">
  Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>shave_image</h4>
<p>Method ShaveImage returns a pointer to the shaved image.  A null image is returned if there is a memory shortage or if the image width or height is zero.</p>

<h4>image</h4>
<p>The image.</p>

<h4>shave_info</h4>
<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="SpliceImage">SpliceImage</a></h2>
</div>

<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>

<p>The format of the SpliceImage method is:</p>

<pre class="code">
  Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>geometry</h4>
<p>Define the region of the image to splice with members x, y, width, and height.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


<div style="margin: auto;">
  <h2><a name="TransformImage">TransformImage</a></h2>
</div>

<p>TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification.  If the operation fails, the original image handle is returned.</p>

<p>The format of the TransformImage method is:</p>

<pre class="code">
  MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
    const char *image_geometry)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image The transformed image is returned as this parameter.</p>

<h4>crop_geometry</h4>
<p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p>

<h4>image_geometry</h4>
<p>An image geometry string.  This geometry defines the final size of the image.</p>


<div style="margin: auto;">
  <h2><a name="TransformImages">TransformImages</a></h2>
</div>

<p>TransformImages() calls TransformImage() on each image of a sequence.</p>

<p>The format of the TransformImage method is:</p>

<pre class="code">
  MagickBooleanType TransformImages(Image **image,
    const char *crop_geometry,const char *image_geometry)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image The transformed image is returned as this parameter.</p>

<h4>crop_geometry</h4>
<p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p>

<h4>image_geometry</h4>
<p>An image geometry string.  This geometry defines the final size of the image.</p>


<div style="margin: auto;">
  <h2><a name="TrimImage">TrimImage</a></h2>
</div>

<p>TrimImage() trims pixels from the image edges.  It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>

<p>The format of the TrimImage method is:</p>

<pre class="code">
  Image *TrimImage(const Image *image,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>


      </td>
      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
    </tr>
  </tbody>
  </table>
  <div id="linkbar">
    <a href="http://redux.imagemagick.org/discussion-server" target="1078991131">Discourse Server</a> |
    <a href="../../www/mailing-list.html">Mailing Lists</a> |
    <a href="http://redux.imagemagick.org/gallery" target="703630496">Image Gallery</a> |
    <a href="http://net11.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="962716201">ImageMagick Studio</a>
  </div>
  <div>
    <span id="footer-west">&copy; 1999-2005 ImageMagick Studio LLC</span>
  </div>
  <div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>