source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/cutsegment.html @ 338

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

update documentation
File size: 5.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cutsegment.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="cutpar.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="extrapolate.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>cutsegment.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 cut p segments into p*n equal parts
65
66
67   
68
69     
70      <a name="#_cutsegment"></a>
71
72      <h2>cutsegment  <font size="-1" color="#006633">
73 basic work
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>cutsegment(<i><a href="#_cutsegment_keyword_x0">x0</a>, <a href="#_cutsegment_keyword_y0">y0</a>, <a href="#_cutsegment_keyword_x1">x1</a>, <a href="#_cutsegment_keyword_y1">y1</a>, <a href="#_cutsegment_keyword_n">n</a></i>, <a href="#_cutsegment_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_cutsegment_keyword_ONSPHERE">ONSPHERE</a>=<i>ONSPHERE</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82  - default: a 3d array (2,n,p) that gives the coordinates of the
83  middle of the cut segments.
84  - if /ENDPOINTS, a 3d array (2,n+1,p) that gives the
85  coordinates of the endpoints of the cutted segments.
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_cutsegment_keyword_x0"></a>
93    <h4>x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104   
105   
106
107    <a name="#_cutsegment_keyword_y0"></a>
108    <h4>y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
120   
121
122    <a name="#_cutsegment_keyword_x1"></a>
123    <h4>x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124      <font size="-1" color="#006633">in</font>
125     
126     
127      <font size="-1" color="#006633">required</font>
128     
129     
130     
131     
132    </h4>
133
134   
135   
136
137    <a name="#_cutsegment_keyword_y1"></a>
138    <h4>y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139      <font size="-1" color="#006633">in</font>
140     
141     
142      <font size="-1" color="#006633">required</font>
143     
144     
145     
146     
147    </h4>
148
149   
150 1d arrays of p elements, the coordinates of the endpoints of the p segments
151
152   
153
154    <a name="#_cutsegment_keyword_n"></a>
155    <h4>n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156      <font size="-1" color="#006633">in</font>
157     
158     
159      <font size="-1" color="#006633">required</font>
160     
161     
162     
163     
164    </h4>
165
166   
167 the number of pieces we want to cut each segment
168
169   
170   
171
172   
173    <h3>Keywords</h3>
174
175   
176    <a name="#_cutsegment_keyword_ENDPOINTS"></a>
177    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178     
179     
180     
181     
182     
183     
184     
185     
186    </h4>
187
188   
189 see returns
190
191   
192    <a name="#_cutsegment_keyword_ONSPHERE"></a>
193    <h4>ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199     
200     
201     
202    </h4>
203
204   
205 to specify that the points are located on a sphere.
206 In this case, x and y correspond to longitude and latitude in degrees.
207
208   
209   
210
211    <h3>Examples</h3><pre>
212 IDL> x0=[2,5]
213 IDL> y0=[5,1]
214 IDL> x1=[9,3]
215 IDL> y1=[1,8]
216 IDL> res=cutsegment(x0, y0, x1, y1, 10)
217 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
218 IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
219 IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
220 IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
221 IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
222
223    </pre><h3>Version history</h3>
224   
225    <h4>Version</h4>
226 $Id: cutsegment.pro 327 2007-12-13 16:22:35Z pinsard $
227
228    <h4>History</h4>
229           S. Masson (smasson@lodyc.jussieu.fr)
230           July 5th, 2002
231
232   
233
234   
235   
236   
237   
238   
239
240   
241   
242   
243   
244   
245   
246   
247
248    <font size="-3"><p>&nbsp;</p></font>
249    <hr size="1" color="#CCCCCC"/>
250     
251
252   
253
254    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
255
256  </body>
257</html>
Note: See TracBrowser for help on using the repository browser.