summaryrefslogtreecommitdiff
path: root/www/api/shear.html
blob: 0a1de36665ec018a8086a0ec382a18995797795a (plain)
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
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta content="en" name="language">
	<title>shear</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">

</head>

<body>

<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
  <input type="hidden" name="domains" value="www.graphicsmagick.org" />
  <input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" />&nbsp;<input type="submit" name="sa" value="Search" /></span>
</form>
</div>


<div class="navmenu">
<ul>
  <li><a href="../index.html">Home</a></li>
  <li><a href="../project.html">Project</a></li>
  <li><a href="../download.html">Download</a></li>
  <li><a href="../README.html">Install</a></li>
  <li><a href="../Hg.html">Source</a></li>
  <li><a href="../NEWS.html">News</a> </li>
  <li><a href="../utilities.html">Utilities</a></li>
  <li><a href="../programming.html">Programming</a></li>
  <li><a href="../reference.html">Reference</a></li>
</ul>
</div>

<div class="document" id="shear">
<h1 class="title">shear</h1>
<p class="subtitle" id="rotate-image-shear-image-or-apply-a-2d-affine-transformation">Rotate image, shear image, or apply a 2D affine transformation</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#affinetransformimage" id="id7">AffineTransformImage</a></p></li>
<li><p><a class="reference internal" href="#autoorientimage" id="id8">AutoOrientImage</a></p></li>
<li><p><a class="reference internal" href="#rotateimage" id="id9">RotateImage</a></p></li>
<li><p><a class="reference internal" href="#shearimage" id="id10">ShearImage</a></p></li>
</ul>
</div>
<div class="section" id="affinetransformimage">
<h1><a class="toc-backref" href="#id7">AffineTransformImage</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AffineTransformImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#affinematrix">AffineMatrix</a> *affine,
                             <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>AffineTransformImage() transforms an image as dictated by the affine matrix.
It allocates the memory necessary for the new Image structure and returns
a pointer to the new image.</p>
<p>The format of the AffineTransformImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AffineTransformImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#affinematrix">AffineMatrix</a> *affine,
                             <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>affine:</dt>
<dd><p>The affine transform.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="autoorientimage">
<h1><a class="toc-backref" href="#id8">AutoOrientImage</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AutoOrientImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const OrientationType current_orientation,
                        <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
<p>AutoOrientImage() returns an image adjusted so that its orientation is
suitable for viewing (i.e. top-left orientation).</p>
<p>The format of the AutoOrientImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AutoOrientImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const OrientationType current_orientation,
                        <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>current_orientation:</dt>
<dd><p>Current image orientation (normally same as
image-&gt;orientation).</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="rotateimage">
<h1><a class="toc-backref" href="#id9">RotateImage</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RotateImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double degrees,
                    <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
<p>Method RotateImage creates a new image that is a rotated copy of an
existing one.  Positive angles rotate counter-clockwise (right-hand rule),
while negative angles rotate clockwise.  Rotated images are usually larger
than the originals and have 'empty' triangular corners.  X axis.  Empty
triangles left over from shearing the image are filled with the color
specified by the image background_color.  RotateImage allocates the memory
necessary for the new Image structure and returns a pointer to the new
image.</p>
<p>Method RotateImage is based on the paper &quot;A Fast Algorithm for General
Raster Rotatation&quot; by Alan W. Paeth.  RotateImage is adapted from a similar
method based on the Paeth paper written by Michael Halle of the Spatial
Imaging Group, MIT Media Lab.</p>
<p>The format of the RotateImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RotateImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double degrees,
                    <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method RotateImage returns a pointer to the image after
rotating.  A null image is returned if there is a memory shortage.</p>
</dd>
<dt>image:</dt>
<dd><p>The image;  returned from
ReadImage.</p>
</dd>
<dt>degrees:</dt>
<dd><p>Specifies the number of degrees to rotate the image.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="shearimage">
<h1><a class="toc-backref" href="#id10">ShearImage</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShearImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double x_shear, const double y_shear,
                   <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
<p>Method ShearImage creates a new image that is a shear_image copy of an
existing one.  Shearing slides one edge of an image along the X or Y
axis, creating a parallelogram.  An X direction shear slides an edge
along the X axis, while a Y direction shear slides an edge along the Y
axis.  The amount of the shear is controlled by a shear angle.  For X
direction shears, x_shear is measured relative to the Y axis, and
similarly, for Y direction shears y_shear is measured relative to the
X axis.  Empty triangles left over from shearing the image are filled
with the color defined by the pixel at location (0,0).  ShearImage
allocates the memory necessary for the new Image structure and returns
a pointer to the new image.</p>
<p>Method ShearImage is based on the paper &quot;A Fast Algorithm for General
Raster Rotatation&quot; by Alan W. Paeth.</p>
<p>The format of the ShearImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShearImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double x_shear, const double y_shear,
                   <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method ShearImage returns a pointer to the image after
rotating.  A null image is returned if there is a memory shortage.</p>
</dd>
<dt>image:</dt>
<dd><p>The image;  returned from
ReadImage.</p>
</dd>
<dt>x_shear, y_shear:</dt>
<dd><p>Specifies the number of degrees to shear the image.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</div>
</div>
</div>


<hr class="docutils">
<div class="document">
    <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
</div>

</div>
</body>
</html>