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 410 411 412 413
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>transform - Transform an Image</title>
<link rel="stylesheet" type="text/css" href="../magick.css">
</head>
<body marginheight="1" marginwidth="1" topmargin="1" leftmargin="1">
<a name="top"></a>
<table border="0" cellpadding="0" cellspacing="0" summary="Masthead" width="100%">
<tbody>
<tr>
<td bgcolor="#003399" width="25%" height="118" background="../../images/background.gif"><a href="http://www.imagemagick.org/"><img src="../../images/script.gif" width="278" height="118" border="0" alt="" /></a></td>
<td bgcolor="#003399" width="60%" height="118" background="../../images/background.gif"><a href="http://www.networkeleven.com/direct.php?magick_all"><img src="../../images/promote.png" border="0" width="186" height="52" vspace="29" alt="Powered by NetworkEleven" /></a></td>
<td bgcolor="#003399" width="114" height="118" align="right"><img src="../../images/sprite.png" width="114" height="118" alt="" /></td>
<td bgcolor="#003399" width="114" height="118" align="right"><a href="http://www.imagemagick.net"><img src="../../images/logo.png" width="114" height="118" border="0" alt="ImageMagick logo" /></a></td>
</tr></tbody></table>
<table align="left" border="0" cellpadding="2" cellspacing="2" summary="Navigation buttons" width="20%">
<tr>
<td>
<form target="_self" action="../../index.html"><input type="submit" title="ImageMagick Home" value=" Home" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/apis.html"><input type="submit" title="ImageMagick API" value=" API " style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/archives.html"><input type="submit" title="ImageMagick Download" value="Download" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td></tr></table>
<div align="right" style="margin-top:3px; padding-right:4px">
<form action="http://studio.imagemagick.org/Sage/scripts/Sage.cgi"><input type="TEXT" name="query" size="32" maxlength="255"> <input type="SUBMIT" name="sa" value="Search" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); bgcolor:#003399; color:#fbc713; font-weight:bold"></form></div>
<table align="left" border="0" cellpadding="10" cellspacing="0" style="margin-top:-17px" width="100%">
<tr>
<td>
<P><a name="__index__"></a></P>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
<ul>
<li><a href="#chopimage">ChopImage</a></li>
<li><a href="#coalesceimages">CoalesceImages</a></li>
<li><a href="#cropimage">CropImage</a></li>
<li><a href="#deconstructimages">DeconstructImages</a></li>
<li><a href="#flattenimage">FlattenImage</a></li>
<li><a href="#flipimage">FlipImage</a></li>
<li><a href="#flopimage">FlopImage</a></li>
<li><a href="#mosaicimages">MosaicImages</a></li>
<li><a href="#rollimage">RollImage</a></li>
<li><a href="#shaveimage">ShaveImage</a></li>
<li><a href="#spliceimage">SpliceImage</a></li>
<li><a href="#transformimage">TransformImage</a></li>
<li><a href="#transformimages">TransformImages</a></li>
<li><a href="#trimimage">TrimImage</a></li>
</ul>
</ul>
<!-- INDEX END -->
<hr />
<P>
</P>
<h1><a name="name">NAME</a></h1>
<P>transform - Transform an Image</P>
<P>
</P>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<P>Image * <strong>ChopImage</strong>( const Image *image, const RectangleInfo *chop_info );</P>
<P>Image * <strong>CoalesceImages</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>CropImage</strong>( const Image *image, const RectangleInfo *geometry, ExceptionInfo *exception );</P>
<P>Image * <strong>DeconstructImages</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>FlattenImage</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>FlipImage</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>FlopImage</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>MosaicImages</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>Image * <strong>RollImage</strong>( const Image *image, const long x_offset, const long y_offset, ExceptionInfo *exception );</P>
<P>Image * <strong>ShaveImage</strong>( const Image *image, const RectangleInfo *shave_info, ExceptionInfo *exception );</P>
<P>Image * <strong>SpliceImage</strong>( const Image *image, const RectangleInfo *geometry, ExceptionInfo *exception );</P>
<P>MagickBooleanType <strong>TransformImage</strong>( Image ** image, const char *crop_geometry, const char *image_geometry );</P>
<P>MagickBooleanType <strong>TransformImages</strong>( Image ** image, const char *crop_geometry, const char *image_geometry );</P>
<P>Image * <strong>TrimImage</strong>( const Image *image, ExceptionInfo *exception );</P>
<P>
</P>
<hr />
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
<P>
</P>
<h2><a name="chopimage">ChopImage</a></h2>
<P><code>Chop()</code> 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>
<blockquote><A HREF="types.html#Image">Image</A> *ChopImage ( const <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#RectangleInfo">RectangleInfo</A> *chop_info ); </blockquote><pre>
ExceptionInfo *exception)</pre>
<P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_image_3a">image:</a></strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong><a name="item_o_chop_info_3a">chop_info:</a></strong><br />
</dt>
<DD>
Define the region of the image to chop.
</dd>
<P></P>
<dt><strong><a name="item_o_exception_3a">exception:</a></strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="coalesceimages">CoalesceImages</a></h2>
<blockquote>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. </blockquote><P>The format of the CoalesceImages method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *CoalesceImages ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image sequence.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="cropimage">CropImage</a></h2>
<blockquote>Use CropImage() to extract a region of the image starting at the offset defined by geometry. </blockquote><P>The format of the CropImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *CropImage ( const <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#RectangleInfo">RectangleInfo</A> *geometry, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong><a name="item_o_geometry_3a">geometry:</a></strong><br />
</dt>
<DD>
Define the region of the image to crop with members x, y, width, and height.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="deconstructimages">DeconstructImages</a></h2>
<blockquote>DeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers. </blockquote><P>The format of the DeconstructImages method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *DeconstructImages ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="flattenimage">FlattenImage</a></h2>
<blockquote>FlattenImage() merges a sequence of images. This is useful for combining Photoshop layers into a single image. </blockquote><P>The format of the FlattenImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *FlattenImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image sequence.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="flipimage">FlipImage</a></h2>
<blockquote>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis. </blockquote><P>The format of the FlipImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *FlipImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="flopimage">FlopImage</a></h2>
<blockquote>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis. </blockquote><P>The format of the FlopImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *FlopImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="mosaicimages">MosaicImages</a></h2>
<blockquote>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. </blockquote><P>The format of the MosaicImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *MosaicImages ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="rollimage">RollImage</a></h2>
<blockquote>RollImage() offsets an image as defined by x_offset and y_offset. </blockquote><P>The format of the RollImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *RollImage ( const <A HREF="types.html#Image">Image</A> *image, const long x_offset, const long y_offset, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong><a name="item_o_x_offset_3a">x_offset:</a></strong><br />
</dt>
<DD>
The number of columns to roll in the horizontal direction.
</dd>
<P></P>
<dt><strong><a name="item_o_y_offset_3a">y_offset:</a></strong><br />
</dt>
<DD>
The number of rows to roll in the vertical direction.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="shaveimage">ShaveImage</a></h2>
<blockquote>ShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new <A HREF="types.html#Image">Image</A> structure and returns a pointer to the new image. </blockquote><P>The format of the ShaveImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *ShaveImage ( const <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#RectangleInfo">RectangleInfo</A> *shave_info, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_shave_image_3a">shave_image:</a></strong><br />
</dt>
<DD>
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.
</dd>
<P></P>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong><a name="item_o_shave_info_3a">shave_info:</a></strong><br />
</dt>
<DD>
Specifies a pointer to a RectangleInfo which defines the region of the image to crop.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="spliceimage">SpliceImage</a></h2>
<blockquote>Use SpliceImage() to splice a solid color into the image as defined by the geometry. </blockquote><P>The format of the SpliceImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *SpliceImage ( const <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#RectangleInfo">RectangleInfo</A> *geometry, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>geometry:</strong><br />
</dt>
<DD>
Define the region of the image to splice with members x, y, width, and height.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="transformimage">TransformImage</a></h2>
<blockquote>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. </blockquote><P>The format of the TransformImage method is:</P>
<blockquote>MagickBooleanType TransformImage ( <A HREF="types.html#Image">Image</A> **image, const char *crop_geometry, const char *image_geometry ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image The transformed image is returned as this parameter.
</dd>
<P></P>
<dt><strong><a name="item_o_crop_geometry_3a">crop_geometry:</a></strong><br />
</dt>
<DD>
A crop geometry string. This geometry defines a subregion of the image to crop.
</dd>
<P></P>
<dt><strong><a name="item_o_image_geometry_3a">image_geometry:</a></strong><br />
</dt>
<DD>
An image geometry string. This geometry defines the final size of the image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="transformimages">TransformImages</a></h2>
<blockquote>TransformImages() calls TransformImage ( ) on each image of a sequence. </blockquote><P>The format of the TransformImage method is:</P>
<blockquote>MagickBooleanType TransformImages ( <A HREF="types.html#Image">Image</A> **image, const char *crop_geometry, const char *image_geometry ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image The transformed image is returned as this parameter.
</dd>
<P></P>
<dt><strong>crop_geometry:</strong><br />
</dt>
<DD>
A crop geometry string. This geometry defines a subregion of the image to crop.
</dd>
<P></P>
<dt><strong>image_geometry:</strong><br />
</dt>
<DD>
An image geometry string. This geometry defines the final size of the image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="trimimage">TrimImage</a></h2>
<blockquote>TrimImage() trims pixels from the image edges. It allocates the memory necessary for the new <A HREF="types.html#Image">Image</A> structure and returns a pointer to the new image. </blockquote><P>The format of the TrimImage method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *TrimImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
</dl>
<HR>
<a href="#top"><img src="../../../images/top.gif" border=0 width=42 height=42 align="right" alt="Top of page"></a>
<form action="http://studio.imagemagick.org/magick/" style="margin-top:5px">
<input type="submit" title="Help!" value="Help!" style="background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold">
<small>"Image manipulation software that works like magick"</small>
</form></td>
</tr></table>
</body>
</html>
|