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

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