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

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.5 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" 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="../../../Interpolation//inrecgrid.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="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" 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">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">
90 given - a list of points, (x,y) position
91       - the x and y limits of a rectangular grid
92 find in which cell is located each given point.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_inrecgrid">
107
108          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories"> 
109 Without loop
110</span></h2>
111       
112          <p class="header">
113            <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>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 the index on the cell according to the 2d array defined by left and bottom.
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132              <span class="attr">type:</span> <span class="value">1d array</span>
133             
134             
135            </h4>
136       
137          <div class="comments">
138 the x position on the points
139</div>
140           
141            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147              <span class="attr">type:</span> <span class="value">1d array</span>
148             
149             
150            </h4>
151       
152          <div class="comments">
153 the y position on the points
154</div>
155           
156            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157              <span class="attr">in</span>
158             
159             
160              <span class="attr">required</span>
161             
162              <span class="attr">type:</span> <span class="value">1d monotonically increasing array</span>
163             
164             
165            </h4>
166       
167          <div class="comments">
168 the position of the "left" border of each cell.
169</div>
170           
171            <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172              <span class="attr">in</span>
173             
174             
175              <span class="attr">required</span>
176             
177              <span class="attr">type:</span> <span class="value">1d monotonically increasing array</span>
178             
179             
180            </h4>
181       
182          <div class="comments">
183 the position of the "bottom" border of each cell.
184</div>
185           
186
187         
188
189         
190
191            <h3>Keywords</h3>
192           
193            <h4 id="_inrecgrid_keyword_OUTPUT2D">OUTPUT2D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194             
195             
196             
197             
198             
199             
200             
201             
202            </h4>
203       
204            <div class="comments">
205 to get the output as a 2d array (2,n_elements(x1d)),
206 with res[0,*] the x index according to the 1d array defined by
207 left and res[1,*] the y index according to the 1d array defined by bottom.
208</div>
209           
210            <h4 id="_inrecgrid_keyword_CHECKOUT">CHECKOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments">
222 = [rbgrid,ubgrid] specify the right and upper boundaries of
223 the grid and check if some points are out.
224</div>
225           
226         
227
228          <h3>Examples</h3><div class="preformat">
229
230 IDL> a=indgen(5)
231 IDL> b=indgen(7)
232 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b)
233 IDL> print, r
234            20          13           7
235 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d)
236 IDL> print, r
237        0.00000      4.00000
238        3.00000      2.00000
239        2.00000      1.00000
240</div>
241          <h3>Version history</h3>
242         
243          <h4>Version</h4><div class="preformat"> $Id: inrecgrid.pro 163 2006-08-29 12:59:46Z navarro $
244</div>
245          <h4>History</h4><div class="preformat">
246 S. Masson (smasson@lodyc.jussieu.fr)
247 July 3rd, 2002
248 October 3rd, 2003: use value_locate
249</div>
250         
251         
252         
253         
254         
255         
256         
257       
258         
259         
260         
261         
262         
263         
264         
265       
266          <h3>Statistics</h3>
267          <table class="statistics">
268            <tr><td>McCabe cyclic</td><td>           7</td></tr>
269            <tr><td>McCabe essential</td><td>           1</td></tr>
270            <tr><td>McCabe modular design</td><td>           1</td></tr>
271          </table>
272         
273       
274        </div>
275       
276      </div>
277
278     
279
280      <div id="tagline">Produced by IDLdoc 2.0.</div>
281
282    </div>
283
284  </body>
285</html>
Note: See TracBrowser for help on using the repository browser.