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

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

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 4.9 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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&lt;&lt; prev file | <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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_ncdf_timeget">
103
104          <h2><a class="top" href="#container">top</a>ncdf_timeget </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME: ncdf_timeget
111
112 PURPOSE: get the time axis fom a netcdf_file and transforms it in
113 julian days of IDL.
114
115 CATEGORY: reading ncdf_file
116
117 CALLING SEQUENCE: time = ncdf_timeget(cdfid, timeid)
118 
119 INPUTS:cdfid: the ID of the ncdf_file, which is already open
120        timeid: the ID or the name of the variable which describe the calendar
121
122 KEYWORD PARAMETERS:
123        /YYYYMMDD: active to obtain the date as a longinterger with
124        the format YearYearYearYearMonthMonthDayDay
125
126        the keyword parameters of ncdf_varget
127
128 OUTPUTS:a long array of IDL julian days
129
130 COMMON BLOCKS:
131
132 SIDE EFFECTS:
133
134 RESTRICTIONS: the calendar variable must have the units attribute
135 folowing the syntaxe bellow:
136
137 time_counter:units = "seconds since 0001-01-01 00:00:00" ;
138 time_counter:units = "hours since 0001-01-01 00:00:00" ;
139 time_counter:units = "days since 1979-01-01 00:00:00" ;
140 time_counter:units = "months since 1979-01-01 00:00:00" ;
141 time_counter:units = "years since 1979-01-01 00:00:00" ;
142
143 EXAMPLE:
144</div>
145
146         
147
148         
149            <h3>Parameters</h3>
150       
151           
152            <h4 id="_ncdf_timeget_param_cdfid">cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153             
154             
155             
156             
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments"></div>
164           
165            <h4 id="_ncdf_timeget_param_timeid">timeid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176          <div class="comments"></div>
177           
178
179         
180
181         
182
183            <h3>Keywords</h3>
184           
185            <h4 id="_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196            <div class="comments"></div>
197           
198            <h4 id="_ncdf_timeget_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209            <div class="comments"></div>
210           
211         
212
213         
214         
215         
216         
217         
218         
219         
220         
221         
222         
223         
224         
225       
226         
227         
228         
229         
230         
231         
232         
233       
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.