source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/lineintersection.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 4.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>lineintersection.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="linearequation.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="protype.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>lineintersection.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 Calculate coordinates of the intersection between 2 straight lines
65 or of a succession of 2 straight lines.
66
67
68   
69
70     
71      <a name="#_lineintersection"></a>
72
73      <h2>lineintersection  <font size="-1" color="#006633"> 
74 Utilities
75 </font></h2>
76
77      <p><font face="Courier"><i>result = </i>lineintersection(<i><a href="#_lineintersection_keyword_abc1">abc1</a>, <a href="#_lineintersection_keyword_abc2">abc2</a></i>, <a href="#_lineintersection_keyword_FLOAT">FLOAT</a>=<i>FLOAT</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3> 
83 2 possibilities:
84      1) by default: it is a vector of complex whose each element is the coordinates
85                     of the intersection point of a pair of straight lines.
86      2) if FLOAT is activated, it is a array of reels of dimension 2,
87         number_of_pairs_of_straight_lines whose each row is the coordinates
88         of the intersection point of a pair of straight line.
89
90
91   
92    <h3>Parameters</h3>
93   
94
95    <a name="#_lineintersection_keyword_abc1"></a>
96    <h4>abc1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
97      <font size="-1" color="#006633">in</font>
98     
99     
100      <font size="-1" color="#006633">required</font>
101     
102      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3d array</i></font>
103     
104     
105    </h4>
106
107   
108 is the first array of dimension 3, number_of_pairs_of_straight_lines,
109 whose each line contain the 3 parameters a,b and c of the first linear
110 equation of the type ax+by+c=0
111
112   
113
114    <a name="#_lineintersection_keyword_abc2"></a>
115    <h4>abc2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116      <font size="-1" color="#006633">in</font>
117     
118     
119      <font size="-1" color="#006633">required</font>
120     
121      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3d array</i></font>
122     
123     
124    </h4>
125
126   
127 is second array of dimension 3, number_of_pairs_of_straight_lines,
128 whose each line contain the 3 parameters a,b and c of the second linear
129 equation of the type ax+by+c=0
130
131   
132   
133
134   
135    <h3>Keywords</h3>
136
137   
138    <a name="#_lineintersection_keyword_FLOAT"></a>
139    <h4>FLOAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140     
141     
142     
143     
144     
145     
146     
147     
148    </h4>
149
150     
151 To return the output as a array of real numbers instead of vectors of
152 complex (by default)
153
154   
155   
156
157    <h3>Examples</h3> 
158 IDL> abc1=linearequation(complex(1,2),[3,4])
159 IDL> abc2=linearequation(complex(1,2),[8,15])
160 IDL> print, lineintersection(abc1, abc2)
161 (      1.00000,      2.00000)
162 IDL> print, lineintersection(abc1, abc2,/float)
163 1.00000      2.00000
164
165    <h3>Version history</h3>
166   
167    <h4>Version</h4> $Id: lineintersection.pro 157 2006-08-21 09:01:50Z navarro $
168
169    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
170          10 juin 2000
171
172   
173
174    <h3>Known issues</h3>
175   
176   
177   
178    <h4>Restrictions</h4> 
179 If the 2 straight line are parallel, we return coordinates
180 (!values.f_nan,!values.f_nan)
181
182 
183 Beware of the precision of the machine which make
184 that calculated coordinates may not exactly verify
185 equations of the pair of straight lines.
186
187
188   
189   
190   
191   
192   
193   
194   
195
196    <font size="-3"><p>&nbsp;</p></font>
197    <hr size="1" color="#CCCCCC"/>
198     
199
200   
201
202    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:57 2006.</font></p>
203
204  </body>
205</html>
Note: See TracBrowser for help on using the repository browser.