source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/projsegment.html @ 338

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

update documentation
File size: 5.3 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>projsegment.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="projsegment.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="../../../../../ToBeReviewed/PLOTS/DIVERS//projsegment.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="placedessin.html">&lt;&lt;prev file</a> | <a href="restoreatt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="projsegment.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">ToBeReviewed/PLOTS/DIVERS/</a></h1>
82      <h2 class="pro_file">projsegment.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 project linearly a segment, a vector whose boundaries are [a,b] on
91 a vector whose boundaries are [c,d]
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_projsegment">
106
107          <h2><a class="top" href="#container">top</a>projsegment <span class="categories">
108 Calculation
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>projsegment(<span class="result"><a href="#_projsegment_param_vecteur">vecteur</a>, <a href="#_projsegment_param_bornes">bornes</a></span>, <a href="#_projsegment_keyword_MP">MP</a>=<span class="result">MP</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 A vector whose new boundaries are specified by BORNES.
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_projsegment_param_vecteur">vecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
131              <span class="attr">type:</span> <span class="value">vector</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 A vector whose the first element must be the smallest one and the last must be the biggest one.
138</div>
139           
140            <h4 id="_projsegment_param_bornes">bornes&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141             
142             
143             
144             
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 New boundaries of the vector.
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_projsegment_keyword_MP">MP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments">
174 Activate this keyword to the function send back this a vector of 2
175 elements which are the m and p of the linear projection y=mx+p used
176 to pass from the [a,b] segment to the [c,d] segment.
177</div>
178           
179         
180
181          <h3>Examples</h3><div class="preformat">
182
183   IDL> a=indgen(9)
184   IDL> print, a
185          0       1       2       3       4       5       6       7       8
186   IDL> print, projsegment(a,[0,80])
187          0      10      20      30      40      50      60      70      80
188   IDL> print, projsegment(a,[0,-80])
189          0     -10     -20     -30     -40     -50     -60     -70     -80
190   IDL> print, projsegment(a,[-80,0])
191        -80     -70     -60     -50     -40     -30     -20     -10      0
192</div>
193          <h3>Version history</h3>
194         
195          <h4>Version</h4><div class="preformat">
196 $Id: projsegment.pro 327 2007-12-13 16:22:35Z pinsard $
197</div>
198          <h4>History</h4><div class="preformat">
199 Sebastien Masson (smasson@lodyc.jussieu.fr)
200                       24/6/1999
201</div>
202         
203         
204         
205         
206         
207         
208         
209       
210         
211         
212         
213         
214         
215         
216         
217       
218          <h3>Statistics</h3>
219          <table class="statistics">
220            <tr><td>McCabe cyclic</td><td>           3</td></tr>
221            <tr><td>McCabe essential</td><td>           1</td></tr>
222            <tr><td>McCabe modular design</td><td>           1</td></tr>
223          </table>
224         
225       
226        </div>
227       
228      </div>
229
230     
231
232      <div id="tagline">Produced by IDLdoc 2.0.</div>
233
234    </div>
235
236  </body>
237</html>
Note: See TracBrowser for help on using the repository browser.