source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/fmask.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation
File size: 3.6 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>fmask.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="fmask.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="../../../../ToBeReviewed/GRILLE//fmask.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="f2v.html">&lt;&lt;prev file</a> | <a href="grille.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="fmask.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">ToBeReviewed/GRILLE/</a></h1>
82      <h2 class="pro_file">fmask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 calculate fmask. Economize memory (we do not need to keep fmask anymore)
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_fmask">
105
106          <h2><a class="top" href="#container">top</a>fmask <span class="categories">
107 Grid
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>fmask()</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 A 3d array corresponding to fmask.
118</div>
119
120         
121
122         
123
124          <h3>Examples</h3><div class="preformat">
125 Used like if fmask was a known array by substituing fmask by (fmask())
126 For example: Instead of write fmask[domainef] we have to write (fmask())[domainef]
127</div>
128          <h3>Version history</h3>
129         
130          <h4>Version</h4><div class="preformat">
131 $Id: fmask.pro 268 2007-08-24 14:07:01Z pinsard $
132</div>
133          <h4>History</h4><div class="preformat">
134 Sebastien Masson (smasson@lodyc.jussieu.fr)
135                       11/12/98
136</div>
137         
138         
139         
140         
141         
142         
143         
144       
145         
146         
147         
148         
149         
150         
151         
152       
153          <h3>Statistics</h3>
154          <table class="statistics">
155            <tr><td>McCabe cyclic</td><td>           6</td></tr>
156            <tr><td>McCabe essential</td><td>           1</td></tr>
157            <tr><td>McCabe modular design</td><td>           1</td></tr>
158          </table>
159         
160       
161        </div>
162       
163      </div>
164
165     
166
167      <div id="tagline">Produced by IDLdoc 2.0.</div>
168
169    </div>
170
171  </body>
172</html>
Note: See TracBrowser for help on using the repository browser.