source: trunk/SRC/Documentation/idldoc_html_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: 6.5 KB
RevLine 
[89]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>
[104]9    <title>inrecgrid.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="inrecgrid.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Interpolation//inrecgrid.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[249]74<a href="inquad.html">&lt;&lt;prev file</a> | <a href="lbcorca.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
[89]82      <h2 class="pro_file">inrecgrid.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
[402]90 given
91  - a list of points, (x,y) position
92  - the x and y limits of a rectangular grid
93
[138]94 find in which cell is located each given point.
[101]95</div>
[89]96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_inrecgrid">
109
[242]110          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories">
[157]111 Without loop
[101]112</span></h2>
[89]113       
114          <p class="header">
[138]115            <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>
[89]116       
117          <div class="comments">
[101]118</div>
[89]119
[138]120          <h3>Return value</h3><div class="preformat">
121 the index on the cell according to the 2d array defined by left and bottom.
[101]122</div>
[89]123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]129              <span class="attr">in</span>
[89]130             
131             
[101]132              <span class="attr">required</span>
[89]133             
[163]134              <span class="attr">type:</span> <span class="value">1d array</span>
[89]135             
136             
137            </h4>
138       
[138]139          <div class="comments">
[163]140 the x position on the points
[138]141</div>
[89]142           
143            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]144              <span class="attr">in</span>
[89]145             
146             
[101]147              <span class="attr">required</span>
[89]148             
[163]149              <span class="attr">type:</span> <span class="value">1d array</span>
[89]150             
151             
152            </h4>
153       
[138]154          <div class="comments">
[163]155 the y position on the points
[138]156</div>
[89]157           
158            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]159              <span class="attr">in</span>
[89]160             
161             
[118]162              <span class="attr">required</span>
[89]163             
[163]164              <span class="attr">type:</span> <span class="value">1d monotonically increasing array</span>
[89]165             
166             
167            </h4>
168       
[138]169          <div class="comments">
170 the position of the "left" border of each cell.
171</div>
[89]172           
173            <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[101]174              <span class="attr">in</span>
[89]175             
176             
[101]177              <span class="attr">required</span>
[89]178             
[163]179              <span class="attr">type:</span> <span class="value">1d monotonically increasing array</span>
[89]180             
181             
182            </h4>
183       
[138]184          <div class="comments">
[118]185 the position of the "bottom" border of each cell.
[101]186</div>
[89]187           
188
189         
190
191         
192
193            <h3>Keywords</h3>
194           
[138]195            <h4 id="_inrecgrid_keyword_OUTPUT2D">OUTPUT2D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
[138]206            <div class="comments">
207 to get the output as a 2d array (2,n_elements(x1d)),
208 with res[0,*] the x index according to the 1d array defined by
209 left and res[1,*] the y index according to the 1d array defined by bottom.
[101]210</div>
[89]211           
[138]212            <h4 id="_inrecgrid_keyword_CHECKOUT">CHECKOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]213             
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
[138]223            <div class="comments">
224 = [rbgrid,ubgrid] specify the right and upper boundaries of
225 the grid and check if some points are out.
[101]226</div>
[89]227           
228         
229
[138]230          <h3>Examples</h3><div class="preformat">
[101]231
[402]232   IDL> a=indgen(5)
233   IDL> b=indgen(7)
234   IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b)
235   IDL> print, r
[101]236            20          13           7
[402]237   IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d)
238   IDL> print, r
[101]239        0.00000      4.00000
240        3.00000      2.00000
241        2.00000      1.00000
[138]242</div>
[101]243          <h3>Version history</h3>
[89]244         
[234]245          <h4>Version</h4><div class="preformat">
[402]246 $Id: inrecgrid.pro 372 2008-08-08 12:31:53Z pinsard $
[118]247</div>
[138]248          <h4>History</h4><div class="preformat">
249 S. Masson (smasson@lodyc.jussieu.fr)
[402]250  - July 3rd, 2002
251  - October 3rd, 2003: use value_locate
[118]252</div>
[89]253         
254         
255         
256         
257         
258         
259         
260       
261         
262         
263         
264         
265         
266         
267         
268       
[163]269          <h3>Statistics</h3>
270          <table class="statistics">
271            <tr><td>McCabe cyclic</td><td>           7</td></tr>
272            <tr><td>McCabe essential</td><td>           1</td></tr>
273            <tr><td>McCabe modular design</td><td>           1</td></tr>
274          </table>
[89]275         
276       
277        </div>
278       
279      </div>
280
281     
282
283      <div id="tagline">Produced by IDLdoc 2.0.</div>
284
285    </div>
286
287  </body>
[249]288</html>
Note: See TracBrowser for help on using the repository browser.