source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_gettime.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_gettime.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="ncdf_getmask.html"><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_gettime.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_gettime"></a>
72
73      <h2>ncdf_gettime  <font size="-1" color="#006633">
74 Read NetCDF file
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>ncdf_gettime(<i><a href="#_ncdf_gettime_keyword_filename">filename</a>[, <a href="#_ncdf_gettime_keyword_cdfid">cdfid</a>]</i>, <a href="#_ncdf_gettime_keyword_CALTYPE">CALTYPE</a>=<i>CALTYPE</i>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<i>string</i>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<i>string</i>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<i>ERR</i>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 a double 1D array of IDL Julian days
84 In case of error return -1 if the time dimension was not found
85               or return -jpt if it as been found that the time dimension size is jpt
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_ncdf_gettime_keyword_filename"></a>
93    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
100     
101     
102    </h4>
103
104   
105 the name of the ncdf_file
106
107   
108
109    <a name="#_ncdf_gettime_keyword_cdfid"></a>
110    <h4>cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111      <font size="-1" color="#006633">in</font>
112     
113      <font size="-1" color="#006633">optional</font>
114     
115     
116      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
117     
118     
119    </h4>
120
121   
122 the ID of the ncdf_file, if the file is already open.
123 if not provided, ncdf_gettime open the file defined by filename
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_ncdf_gettime_keyword_CALTYPE"></a>
133    <h4>CALTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139     
140     
141     
142    </h4>
143
144   
145 Used to specify (or orverwrite) the type of calendar that should be
146 used. We accept only 'noleap', '360d', 'greg' and 'gregorian'. By
147 default, we use the type of calendar defied in the attibute
148 calendar. if not, we define it as gregorian.
149
150   
151    <a name="#_ncdf_gettime_keyword_TIMEVAR"></a>
152    <h4>TIMEVAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153     
154     
155     
156     
157     
158      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
159     
160     
161    </h4>
162
163   
164 It define the name of the variable that
165 contains the time axis. This keyword can be useful if there
166 is no unlimited dimension or if the time axis selected by default
167 (the first 1D array with unlimited dimension) is not the good one.
168
169   
170    <a name="#_ncdf_gettime_keyword_CALLER"></a>
171    <h4>CALLER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172     
173     
174     
175      <font size="-1" color="#006633">required</font>
176     
177      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
178     
179     
180    </h4>
181
182   
183 Used to specify the error messages. Give the name of the calling
184 procedure. It can be only '<a href="..//ToBeReviewed/LECTURE/read_ncdf.html">read_ncdf</a>' or '<a href="..//ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html">scanfile</a>'.
185
186
187   
188    <a name="#_ncdf_gettime_keyword_ERR"></a>
189    <h4>ERR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190     
191     
192     
193     
194     
195     
196     
197     
198    </h4>
199
200   
201 Set this keyword to a named variable in which the value of the error
202 message will be returned
203
204   
205    <a name="#_ncdf_gettime_keyword__EXTRA"></a>
206    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207     
208     
209     
210     
211     
212     
213     
214     
215    </h4>
216
217   
218 _EXTRA to be able to call ncdf_getmask with _extra keyword
219
220   
221   
222
223   
224    </pre><h3>Version history</h3>
225   
226    <h4>Version</h4>
227 $Id: ncdf_gettime.pro 401 2009-07-23 08:48:16Z smasson $
228    <h4>History</h4>
229 August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
230
231   
232
233    <h3>Known issues</h3>
234   
235   
236   
237    <h4>Restrictions</h4>
238 the calendar variable must have the units attribute
239 following the syntax below:
240
241 time_counter:units = "seconds since 0001-01-01 00:00:00" ;
242 time_counter:units = "hours since 0001-01-01 00:00:00" ;
243 time_counter:units = "days since 1979-01-01 00:00:00" ;
244 time_counter:units = "months since 1979-01-01 00:00:00" ;
245 time_counter:units = "years since 1979-01-01 00:00:00" ;
246
247
248   
249   
250   
251   
252   
253   
254   
255
256    <font size="-3"><p>&nbsp;</p></font>
257    <hr size="1" color="#CCCCCC"/>
258     
259
260   
261
262    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
263
264  </body>
265</html>
Note: See TracBrowser for help on using the repository browser.