source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_timeget.html @ 413

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

update documentation
File size: 5.4 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>ncdf_timeget.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="ncdf_timeget.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="../../../ReadWrite//ncdf_timeget.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="ncdf_getaxis.html">&lt;&lt;prev file</a> | <a href="read_grads.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_timeget.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">ReadWrite/</a></h1>
82      <h2 class="pro_file">ncdf_timeget.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 get the time axis from a netcdf_file and transforms it in
91 Julian days of IDL.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_ncdf_timeget">
106
107          <h2><a class="top" href="#container">top</a>ncdf_timeget <span class="categories">
108 Reading
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>ncdf_timeget(<span class="result"><a href="#_ncdf_timeget_param_cdfid">cdfid</a>, <a href="#_ncdf_timeget_param_timeid">timeid</a></span>, <a href="#_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD</a>=<span class="result">YYYYMMDD</span>, <a href="#_ncdf_timeget_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 a long array of IDL Julian days
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_ncdf_timeget_param_cdfid">cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 the ID of the ncdf_file, which is already open
138</div>
139           
140            <h4 id="_ncdf_timeget_param_timeid">timeid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 the ID or the name of the variable which describe the calendar
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments">
174 active to obtain the date as a long integer with
175 the format YearYearYearYearMonthMonthDayDay
176</div>
177           
178            <h4 id="_ncdf_timeget_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189            <div class="comments">
190 the keyword parameters of ncdf_varget
191</div>
192           
193         
194
195         
196          <h3>Version history</h3>
197         
198          <h4>Version</h4><div class="preformat">
199 $Id: ncdf_timeget.pro 238 2007-03-27 13:43:18Z pinsard $</div>
200          <h4>History</h4><div class="preformat">
201 Sebastien Masson (smasson@lodyc.jussieu.fr)
202                      June 2001</div>
203         
204         
205          <h3>Known issues</h3>
206         
207         
208         
209          <h4>Restrictions</h4><div class="preformat">
210 the calendar variable must have the units attribute
211 following the syntax bellow:
212
213 time_counter:units = "seconds since 0001-01-01 00:00:00" ;
214 time_counter:units = "hours since 0001-01-01 00:00:00" ;
215 time_counter:units = "days since 1979-01-01 00:00:00" ;
216 time_counter:units = "months since 1979-01-01 00:00:00" ;
217 time_counter:units = "years since 1979-01-01 00:00:00" ;
218</div>
219       
220         
221         
222         
223         
224         
225         
226         
227       
228          <h3>Statistics</h3>
229          <table class="statistics">
230            <tr><td>McCabe cyclic</td><td>          13</td></tr>
231            <tr><td>McCabe essential</td><td>           1</td></tr>
232            <tr><td>McCabe modular design</td><td>           1</td></tr>
233          </table>
234         
235       
236        </div>
237       
238      </div>
239
240     
241
242      <div id="tagline">Produced by IDLdoc 2.0.</div>
243
244    </div>
245
246  </body>
247</html>
Note: See TracBrowser for help on using the repository browser.