source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/f2v.html @ 338

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

update documentation
File size: 4.1 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>f2v.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="f2v.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="../../../../ToBeReviewed/GRILLE//f2v.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
[189]74<a href="domdef.html">&lt;&lt;prev file</a> | <a href="fmask.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="f2v.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">ToBeReviewed/GRILLE/</a></h1>
[89]82      <h2 class="pro_file">f2v.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]89      <div id="file_comments">
[234]90 Allows to pass a field referring to the grid F on the grid V,
91 thanks to the average:
92 res = 0.5*(res + shift(res, 1, 0))
[142]93</div>
[89]94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_f2v">
107
[234]108          <h2><a class="top" href="#container">top</a>f2v <span class="categories">
[157]109 Grid
[142]110</span></h2>
[89]111       
112          <p class="header">
113            <span class="result">result = </span>f2v(<span class="result"><a href="#_f2v_param_temp">temp</a></span>)</p>
114       
115          <div class="comments">
[142]116</div>
[89]117
[142]118          <h3>Return value</h3><div class="preformat">
[290]119 a 2d, 3d or 4d array
[142]120</div>
[89]121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_f2v_param_temp">temp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]127              <span class="attr">in</span>
[89]128             
129             
[142]130              <span class="attr">required</span>
[89]131             
132             
133             
134             
135            </h4>
136       
[142]137          <div class="comments">
138 A 2, 3 or 4d array
139</div>
[89]140           
141
142         
143
144         
145
146         
[142]147          <h3>Version history</h3>
[89]148         
[142]149          <h4>Version</h4><div class="preformat">
[338]150 $Id: f2v.pro 325 2007-12-06 10:04:53Z pinsard $
[142]151</div>
152          <h4>History</h4><div class="preformat">
[157]153 From Marina Levy's programs
154 Sebastien Masson (smasson@lodyc.jussieu.fr):
155 Validation. 5/6/2000
156</div>
[89]157         
158         
[142]159          <h3>Known issues</h3>
[89]160         
161         
162         
[234]163          <h4>Restrictions</h4><div class="preformat">
164 Force parameters of the zoom on the grid V to be the same as
[142]165 those on the grid T.
166
[234]167
168 Points which can not be calculated are put at the value NaN
[142]169 consecrated by IDL: !values.f_nan
170</div>
[89]171       
[142]172          <h3>Other attributes</h3>
[89]173         
174         
[142]175          <h4>Uses routines</h4><div class="preformat">
176 common.pro
177</div>
[89]178         
179         
180         
181       
[163]182          <h3>Statistics</h3>
183          <table class="statistics">
184            <tr><td>McCabe cyclic</td><td>          32</td></tr>
185            <tr><td>McCabe essential</td><td>           1</td></tr>
186            <tr><td>McCabe modular design</td><td>           1</td></tr>
187          </table>
[89]188         
189       
190        </div>
191       
192      </div>
193
194     
195
196      <div id="tagline">Produced by IDLdoc 2.0.</div>
197
198    </div>
199
200  </body>
[249]201</html>
Note: See TracBrowser for help on using the repository browser.