source: trunk/SRC/Documentation/idldoc_html_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: 6.0 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>lineintersection.pro (SAXO 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="lineintersection.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Utilities//lineintersection.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" 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="linearequation.html">&lt;&lt;prev file</a> | <a href="mergeonline_help.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="lineintersection.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">Utilities/</a></h1>
82      <h2 class="pro_file">lineintersection.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Calculate coordinates of the intersection between 2 straight lines
91 or of a succession of 2 straight lines.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_lineintersection">
106
107          <h2><a class="top" href="#container">top</a>lineintersection <span class="categories">
108 Utilities
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>lineintersection(<span class="result"><a href="#_lineintersection_param_abc1">abc1</a>, <a href="#_lineintersection_param_abc2">abc2</a></span>, <a href="#_lineintersection_keyword_FLOAT">FLOAT</a>=<span class="result">FLOAT</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 2 possibilities:
119      1) by default: it is a vector of complex whose each element is the coordinates
120                     of the intersection point of a pair of straight lines.
121      2) if FLOAT is activated, it is a array of reals of dimension 2,
122         number_of_pairs_of_straight_lines whose each row is the coordinates
123         of the intersection point of a pair of straight line.
124</div>
125
126         
127            <h3>Parameters</h3>
128       
129           
130            <h4 id="_lineintersection_param_abc1">abc1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131              <span class="attr">in</span>
132             
133             
134              <span class="attr">required</span>
135             
136              <span class="attr">type:</span> <span class="value">3d array</span>
137             
138             
139            </h4>
140       
141          <div class="comments">
142 is the first array of dimension 3, number_of_pairs_of_straight_lines,
143 whose each line contain the 3 parameters a, b and c of the first linear
144 equation of the type ax+by+c=0
145</div>
146           
147            <h4 id="_lineintersection_param_abc2">abc2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148              <span class="attr">in</span>
149             
150             
151              <span class="attr">required</span>
152             
153              <span class="attr">type:</span> <span class="value">3d array</span>
154             
155             
156            </h4>
157       
158          <div class="comments">
159 is second array of dimension 3, number_of_pairs_of_straight_lines,
160 whose each line contain the 3 parameters a, b and c of the second linear
161 equation of the type ax+by+c=0
162</div>
163           
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
171            <h4 id="_lineintersection_keyword_FLOAT">FLOAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182            <div class="comments">
183 To return the output as a array of real numbers instead of vectors of
184 complex (by default)
185</div>
186           
187         
188
189          <h3>Examples</h3><div class="preformat">
190 IDL> abc1=linearequation(complex(1,2),[3,4])
191 IDL> abc2=linearequation(complex(1,2),[8,15])
192 IDL> print, lineintersection(abc1, abc2)
193 (      1.00000,      2.00000)
194 IDL> print, lineintersection(abc1, abc2,/float)
195 1.00000      2.00000
196</div>
197          <h3>Version history</h3>
198         
199          <h4>Version</h4><div class="preformat">
200 $Id: lineintersection.pro 327 2007-12-13 16:22:35Z pinsard $
201</div>
202          <h4>History</h4><div class="preformat">
203 Sebastien Masson (smasson@lodyc.jussieu.fr)
204          10 juin 2000
205</div>
206         
207         
208          <h3>Known issues</h3>
209         
210         
211         
212          <h4>Restrictions</h4><div class="preformat">
213 If the 2 straight lines are parallel, we return coordinates
214 (!values.f_nan,!values.f_nan)
215
216 Beware of the precision of the machine which make
217 that calculated coordinates may not exactly verify
218 equations of the pair of straight lines.
219</div>
220       
221         
222         
223         
224         
225         
226         
227         
228       
229          <h3>Statistics</h3>
230          <table class="statistics">
231            <tr><td>McCabe cyclic</td><td>           3</td></tr>
232            <tr><td>McCabe essential</td><td>           1</td></tr>
233            <tr><td>McCabe modular design</td><td>           1</td></tr>
234          </table>
235         
236       
237        </div>
238       
239      </div>
240
241     
242
243      <div id="tagline">Produced by IDLdoc 2.0.</div>
244
245    </div>
246
247  </body>
248</html>
Note: See TracBrowser for help on using the repository browser.