source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_timeget.html @ 168

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

Main document available on top directory, Source links available in idldoc html output
File size: 4.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_timeget.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href=""><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="read_grads.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ReadWrite/</font></h1>
58    <h2>ncdf_timeget.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 get the time axis from a netcdf_file and transforms it in
65 Julian days of IDL.
66
67
68   
69
70     
71      <a name="#_ncdf_timeget"></a>
72
73      <h2>ncdf_timeget  <font size="-1" color="#006633"> 
74 Reading
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>ncdf_timeget(<i><a href="#_ncdf_timeget_keyword_cdfid">cdfid</a>, <a href="#_ncdf_timeget_keyword_timeid">timeid</a></i>, <a href="#_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD</a>=<i>YYYYMMDD</i>, <a href="#_ncdf_timeget_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79   
80
81    <h3>Return value</h3>
82 a long array of IDL Julian days
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_ncdf_timeget_keyword_cdfid"></a>
90    <h4>cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96     
97     
98     
99    </h4>
100
101   
102 the ID of the ncdf_file, which is already open
103
104   
105
106    <a name="#_ncdf_timeget_keyword_timeid"></a>
107    <h4>timeid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108      <font size="-1" color="#006633">in</font>
109     
110     
111      <font size="-1" color="#006633">required</font>
112     
113     
114     
115     
116    </h4>
117
118   
119 the ID or the name of the variable which describe the calendar
120
121   
122   
123
124   
125    <h3>Keywords</h3>
126
127   
128    <a name="#_ncdf_timeget_keyword_YYYYMMDD"></a>
129    <h4>YYYYMMDD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130     
131     
132     
133     
134     
135     
136     
137     
138    </h4>
139
140   
141 active to obtain the date as a long integer with
142 the format YearYearYearYearMonthMonthDayDay
143
144   
145    <a name="#_ncdf_timeget_keyword__EXTRA"></a>
146    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157   
158 the keyword parameters of ncdf_varget
159
160   
161   
162
163   
164    <h3>Version history</h3>
165   
166    <h4>Version</h4> $Id: ncdf_timeget.pro 163 2006-08-29 12:59:46Z navarro $
167    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
168                      June 2001
169   
170
171    <h3>Known issues</h3>
172   
173   
174   
175    <h4>Restrictions</h4>
176 the calendar variable must have the units attribute
177 following the syntax bellow:
178
179 time_counter:units = "seconds since 0001-01-01 00:00:00" ;
180 time_counter:units = "hours since 0001-01-01 00:00:00" ;
181 time_counter:units = "days since 1979-01-01 00:00:00" ;
182 time_counter:units = "months since 1979-01-01 00:00:00" ;
183 time_counter:units = "years since 1979-01-01 00:00:00" ;
184
185
186   
187   
188   
189   
190   
191   
192   
193
194    <font size="-3"><p>&nbsp;</p></font>
195    <hr size="1" color="#CCCCCC"/>
196     
197
198   
199
200    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:36 2006.</font></p>
201
202  </body>
203</html>
Note: See TracBrowser for help on using the repository browser.