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

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

update documentation
File size: 5.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>inrecgrid.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="inquad.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="lbcorca.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>inrecgrid.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 given - a list of points, (x,y) position
65       - the x and y limits of a rectangular grid
66 find in which cell is located each given point.
67
68
69   
70
71     
72      <a name="#_inrecgrid"></a>
73
74      <h2>inrecgrid  <font size="-1" color="#006633">
75 Without loop
76</font></h2>
77
78      <p><font face="Courier"><i>result = </i>inrecgrid(<i><a href="#_inrecgrid_keyword_x1d">x1d</a>, <a href="#_inrecgrid_keyword_y1d">y1d</a>, <a href="#_inrecgrid_keyword_left">left</a>, <a href="#_inrecgrid_keyword_bottom">bottom</a></i>, <a href="#_inrecgrid_keyword_OUTPUT2D">OUTPUT2D</a>=<i>OUTPUT2D</i>, <a href="#_inrecgrid_keyword_CHECKOUT">CHECKOUT</a>=<i>CHECKOUT</i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3>
84 the index on the cell according to the 2d array defined by left and bottom.
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_inrecgrid_keyword_x1d"></a>
92    <h4>x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
98      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d array</i></font>
99     
100     
101    </h4>
102
103   
104 the x position on the points
105
106   
107
108    <a name="#_inrecgrid_keyword_y1d"></a>
109    <h4>y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d array</i></font>
116     
117     
118    </h4>
119
120   
121 the y position on the points
122
123   
124
125    <a name="#_inrecgrid_keyword_left"></a>
126    <h4>left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127      <font size="-1" color="#006633">in</font>
128     
129     
130      <font size="-1" color="#006633">required</font>
131     
132      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d monotonically increasing array</i></font>
133     
134     
135    </h4>
136
137   
138 the position of the "left" border of each cell.
139
140   
141
142    <a name="#_inrecgrid_keyword_bottom"></a>
143    <h4>bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144      <font size="-1" color="#006633">in</font>
145     
146     
147      <font size="-1" color="#006633">required</font>
148     
149      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d monotonically increasing array</i></font>
150     
151     
152    </h4>
153
154   
155 the position of the "bottom" border of each cell.
156
157   
158   
159
160   
161    <h3>Keywords</h3>
162
163   
164    <a name="#_inrecgrid_keyword_OUTPUT2D"></a>
165    <h4>OUTPUT2D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166     
167     
168     
169     
170     
171     
172     
173     
174    </h4>
175
176   
177 to get the output as a 2d array (2,n_elements(x1d)),
178 with res[0,*] the x index according to the 1d array defined by
179 left and res[1,*] the y index according to the 1d array defined by bottom.
180
181   
182    <a name="#_inrecgrid_keyword_CHECKOUT"></a>
183    <h4>CHECKOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184     
185     
186     
187     
188     
189     
190     
191     
192    </h4>
193
194   
195 = [rbgrid,ubgrid] specify the right and upper boundaries of
196 the grid and check if some points are out.
197
198   
199   
200
201    <h3>Examples</h3><pre>
202
203 IDL> a=indgen(5)
204 IDL> b=indgen(7)
205 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b)
206 IDL> print, r
207            20          13           7
208 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d)
209 IDL> print, r
210        0.00000      4.00000
211        3.00000      2.00000
212        2.00000      1.00000
213
214    </pre><h3>Version history</h3>
215   
216    <h4>Version</h4>
217 $Id: inrecgrid.pro 327 2007-12-13 16:22:35Z pinsard $
218
219    <h4>History</h4>
220 S. Masson (smasson@lodyc.jussieu.fr)
221 July 3rd, 2002
222 October 3rd, 2003: use value_locate
223
224   
225
226   
227   
228   
229   
230   
231
232   
233   
234   
235   
236   
237   
238   
239
240    <font size="-3"><p>&nbsp;</p></font>
241    <hr size="1" color="#CCCCCC"/>
242     
243
244   
245
246    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
247
248  </body>
249</html>
Note: See TracBrowser for help on using the repository browser.