source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/quadrilateral2square.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 7.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>quadrilateral2square.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="quadrilateral2square.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="neighbor.html">&lt;&lt;prev file</a> | <a href="spl_fstdrv.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="quadrilateral2square.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">Interpolation/</a></h1>
82      <h2 class="pro_file">quadrilateral2square.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_quadrilateral2square">
103
104          <h2><a class="top" href="#container">top</a>quadrilateral2square </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>quadrilateral2square(<span class="result"><a href="#_quadrilateral2square_param_x0in">x0in</a>, <a href="#_quadrilateral2square_param_y0in">y0in</a>, <a href="#_quadrilateral2square_param_x1in">x1in</a>, <a href="#_quadrilateral2square_param_y1in">y1in</a>, <a href="#_quadrilateral2square_param_x2in">x2in</a>, <a href="#_quadrilateral2square_param_y2in">y2in</a>, <a href="#_quadrilateral2square_param_x3in">x3in</a>, <a href="#_quadrilateral2square_param_y3in">y3in</a>, <a href="#_quadrilateral2square_param_xxin">xxin</a>, <a href="#_quadrilateral2square_param_yyin">yyin</a></span>, <a href="#_quadrilateral2square_keyword_PERF">PERF</a>=<span class="result">PERF</span>)</p>
108       
109          <div class="comments">
110 NAME:quadrilateral2square
111
112 PURPOSE:warm (or map) an arbitrary quadrilateral onto a unit square
113 according to the 4-point correspondences:
114       (x0,y0) -> (0,0)
115       (x1,y1) -> (1,0)
116       (x2,y2) -> (1,1)
117       (x3,y3) -> (0,1)
118 This is the inverse function of square2quadrilateral.pro
119 The mapping is done using perspective transformation which preserve
120 lines in all orientations and permit quadrilateral to quadrilateral
121 mappings. see ref. bellow.
122
123 CATEGORY:image/grid manipulation
124
125 CALLING SEQUENCE:
126
127     res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3,xin,yin)
128 
129 INPUTS:
130
131     x0,y0,x1,y1,x2,y2,x3,y3 the coordinates of the quadrilateral
132     (see above for correspondance with the unit square). Can be
133     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are
134     given in the anticlockwise order.
135
136     xin,yin:the coordinates of the point(s) for which we want to do the
137     mapping. Can be scalar or array.
138
139 KEYWORD PARAMETERS:
140
141    /DOUBLE: use double precision to perform the computation
142
143 OUTPUTS:
144
145     (2,n) array: the new coodinates (xout, yout) of the (xin,yin)
146     point(s) after mapping.
147     If xin is a scalar, then n is equal to the number of elements of
148     x0. If xin is an array , then n is equal to the number of
149     elements of xin.
150
151 COMMON BLOCKS:none
152
153 SIDE EFFECTS:
154
155 RESTRICTIONS: I think degenerated quadrilateral (e.g. flat of
156 twisted) is not work. This has to be tested.
157
158 EXAMPLE:
159
160 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1
161 IDL> tracegrille, findgen(11)*.1, findgen(11)*.1,color=indgen(12)*20
162 IDL> xin = (findgen(11)*.1)#replicate(1, 11)
163 IDL> yin = replicate(1, 11)#(findgen(11)*.1)
164 IDL> out = square2quadrilateral(2,1,3,0,5,1,2,3, xin, yin)
165 IDL> tracegrille, reform(out[0,*],11,11), reform(out[1,*],11,11),color=indgen(12)*20
166
167 IDL> inorg=quadrilateral2square(2,1,3,0,5,1,2,3,out[0,*],out[1,*])
168 IDL> tracegrille, reform(inorg[0,*],11,11), reform(inorg[1,*],11,11),color=indgen(12)*20
169
170 MODIFICATION HISTORY:</div>
171
172         
173
174         
175            <h3>Parameters</h3>
176       
177           
178            <h4 id="_quadrilateral2square_param_x0in">x0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments"></div>
190           
191            <h4 id="_quadrilateral2square_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202          <div class="comments"></div>
203           
204            <h4 id="_quadrilateral2square_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
206             
207             
208             
209             
210             
211             
212             
213            </h4>
214       
215          <div class="comments"></div>
216           
217            <h4 id="_quadrilateral2square_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223             
224             
225             
226            </h4>
227       
228          <div class="comments"></div>
229           
230            <h4 id="_quadrilateral2square_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231             
232             
233             
234             
235             
236             
237             
238             
239            </h4>
240       
241          <div class="comments"></div>
242           
243            <h4 id="_quadrilateral2square_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244             
245             
246             
247             
248             
249             
250             
251             
252            </h4>
253       
254          <div class="comments"></div>
255           
256            <h4 id="_quadrilateral2square_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257             
258             
259             
260             
261             
262             
263             
264             
265            </h4>
266       
267          <div class="comments"></div>
268           
269            <h4 id="_quadrilateral2square_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
270             
271             
272             
273             
274             
275             
276             
277             
278            </h4>
279       
280          <div class="comments"></div>
281           
282            <h4 id="_quadrilateral2square_param_xxin">xxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293          <div class="comments"></div>
294           
295            <h4 id="_quadrilateral2square_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296             
297             
298             
299             
300             
301             
302             
303             
304            </h4>
305       
306          <div class="comments"></div>
307           
308
309         
310
311         
312
313            <h3>Keywords</h3>
314           
315            <h4 id="_quadrilateral2square_keyword_PERF">PERF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316             
317             
318             
319             
320             
321             
322             
323             
324            </h4>
325       
326            <div class="comments"></div>
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        </div>
354       
355      </div>
356
357     
358
359      <div id="tagline">Produced by IDLdoc 2.0.</div>
360
361    </div>
362
363  </body>
364</html>
Note: See TracBrowser for help on using the repository browser.