source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/inrecgrid.html @ 104

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO 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>inrecgrid.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="inrecgrid.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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="inquad.html">&lt;&lt;prev file</a> | <a href="ll_narcs_distances.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inrecgrid.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Interpolation/</a></h1>
82      <h2 class="pro_file">inrecgrid.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> given - a list of points, (x,y) position 
90                - the x and y limits of a rectangular grid
91          find in which cell is located each given point.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_inrecgrid">
106
107          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories"> no DO loop, use the wonderfull value_locate function!
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>inrecgrid(<span class="result"><a href="#_inrecgrid_param_x1d">x1d</a>, <a href="#_inrecgrid_param_y1d">y1d</a>, <a href="#_inrecgrid_param_left">left</a>, <a href="#_inrecgrid_param_bottom">bottom</a></span>, <a href="#_inrecgrid_keyword_output2d">output2d</a>=<span class="result">output2d</span>, <a href="#_inrecgrid_keyword_checkout">checkout</a>=<span class="result">checkout</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="value"> the index on the cell accoring to the 2d array defined by
117 left and bottom.
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">  a 1d array, the x position on the points</div>
136           
137            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments">  a 1d, monotonically increasing array, the position of the
149    "left" border of each cell.</div>
150           
151            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments"></div>
163           
164            <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165              <span class="attr">in</span>
166             
167             
168              <span class="attr">required</span>
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments">  a 1d, monotonically increasing array, the position of the
176    "bottom" border of each cell.
177
178</div>
179           
180
181         
182
183         
184
185            <h3>Keywords</h3>
186           
187            <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
188             
189             
190             
191             
192             
193             
194             
195             
196            </h4>
197       
198            <div class="comments"> to get the output as a 2d array (2,n_elements(x1d)),
199    with res[0,*] the x index accoring to the 1d array defined by
200    left and res[1,*] the y index accoring to the 1d array defined by
201    bottom.
202</div>
203           
204            <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
206             
207             
208             
209             
210             
211             
212             
213            </h4>
214       
215            <div class="comments">=[rbgrid,ubgrid] specify the right and upper bondaries of
216    the grid and check if some points are out.
217</div>
218           
219         
220
221          <h3>Examples</h3><div class="value"> 
222 res = inrecgrid(xin, yin, left, bottom)
223
224 
225
226  IDL> a=indgen(5)
227  IDL> b=indgen(7)
228  IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b)
229  IDL> print, r
230            20          13           7
231  IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d)
232  IDL> print, r
233        0.00000      4.00000
234        3.00000      2.00000
235        2.00000      1.00000
236  </div>
237          <h3>Version history</h3>
238         
239         
240          <h4>History</h4><div class="value">
241            S. Masson (smasson@lodyc.jussieu.fr)
242                      July 3rd, 2002
243                      October 3rd, 2003: use value_locate</div>
244         
245         
246         
247         
248         
249         
250         
251       
252         
253         
254         
255         
256         
257         
258         
259       
260         
261       
262        </div>
263       
264      </div>
265
266     
267
268      <div id="tagline">Produced by IDLdoc 2.0.</div>
269
270    </div>
271
272  </body>
273</html>
Note: See TracBrowser for help on using the repository browser.