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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.8 KB
RevLine 
[163]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">
[177]52<a href="mergeonline_help.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
[163]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
[234]63   
64 Calculate coordinates of the intersection between 2 straight lines
[163]65 or of a succession of 2 straight lines.
66
67
68   
69
70     
71      <a name="#_lineintersection"></a>
72
[234]73      <h2>lineintersection  <font size="-1" color="#006633">
[163]74 Utilities
[234]75</font></h2>
[163]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
[234]82    <h3>Return value</h3>
[163]83 2 possibilities:
[234]84      1) by default: it is a vector of complex whose each element is the coordinates
[163]85                     of the intersection point of a pair of straight lines.
[242]86      2) if FLOAT is activated, it is a array of reals of dimension 2,
[234]87         number_of_pairs_of_straight_lines whose each row is the coordinates
[163]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   
[234]108 is the first array of dimension 3, number_of_pairs_of_straight_lines,
[242]109 whose each line contain the 3 parameters a, b and c of the first linear
[163]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   
[234]127 is second array of dimension 3, number_of_pairs_of_straight_lines,
[242]128 whose each line contain the 3 parameters a, b and c of the second linear
[163]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
[234]150   
151 To return the output as a array of real numbers instead of vectors of
[163]152 complex (by default)
153
154   
155   
156
[234]157    <h3>Examples</h3><pre>
[163]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
[234]165    </pre><h3>Version history</h3>
[163]166   
[234]167    <h4>Version</h4>
[338]168 $Id: lineintersection.pro 327 2007-12-13 16:22:35Z pinsard $
[163]169
[234]170    <h4>History</h4>
171 Sebastien Masson (smasson@lodyc.jussieu.fr)
[163]172          10 juin 2000
173
174   
175
176    <h3>Known issues</h3>
177   
178   
179   
[234]180    <h4>Restrictions</h4>
[242]181 If the 2 straight lines are parallel, we return coordinates
[163]182 (!values.f_nan,!values.f_nan)
183
[234]184 Beware of the precision of the machine which make
185 that calculated coordinates may not exactly verify
[163]186 equations of the pair of straight lines.
187
188
189   
190   
191   
192   
193   
194   
195   
196
197    <font size="-3"><p>&nbsp;</p></font>
198    <hr size="1" color="#CCCCCC"/>
199     
200
201   
202
[187]203    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]204
205  </body>
[249]206</html>
Note: See TracBrowser for help on using the repository browser.