source: trunk/SRC/Documentation/idldoc_assistant_output/Calendar/date2jul.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>date2jul.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="caldat.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="date2string.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Calendar/</font></h1>
58    <h2>date2jul.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 gives Julian day equivalent of a date given in yyyymmdd format
65 This is the inverse of the function <a href="..//Calendar/jul2date.html">jul2date</a>.
66
67
68   
69
70     
71      <a name="#_date2jul"></a>
72
73      <h2>date2jul  <font size="-1" color="#006633">
74 Calendar
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>date2jul(<i><a href="#_date2jul_keyword_date">date</a></i>, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<i>GRADS</i>, <a href="#_date2jul_keyword_MONTH">MONTH</a>=<i>MONTH</i>, <a href="#_date2jul_keyword_DAY">DAY</a>=<i>DAY</i>, <a href="#_date2jul_keyword_YEAR">YEAR</a>=<i>YEAR</i>, <a href="#_date2jul_keyword_HOUR">HOUR</a>=<i>HOUR</i>, <a href="#_date2jul_keyword_MINUTE">MINUTE</a>=<i>MINUTE</i>, <a href="#_date2jul_keyword_SECOND">SECOND</a>=<i>SECOND</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 Julian day with the same format (long or double) as the input parameter
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_date2jul_keyword_date"></a>
91    <h4>date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>long or double, scalar or array</i></font>
98     
99     
100    </h4>
101
102   
103 longword integer with yyyymmdd format or double-precision
104 floating-point with yyyymmdd.xx where xx is the fraction of the day
105 (xx=0 at 0am and 5 at 12am)
106
107   
108   
109
110   
111    <h3>Keywords</h3>
112
113   
114    <a name="#_date2jul_keyword_GRADS"></a>
115    <h4>GRADS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122     
123     
124    </h4>
125
126   
127 if  1 <= year <= 49 --> year = 2000 + year
128 if 50 <= year <= 99 --> year = 1900 + year
129
130   
131    <a name="#_date2jul_keyword_MONTH"></a>
132    <h4>MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
133     
134     
135     
136     
137     
138     
139     
140     
141    </h4>
142
143   
144 Set this keyword equal to a named variable that will receive a
145 longword integer or longword integer array representing the number of
146 the desired month (1 = January, ..., 12 = December).
147
148   
149    <a name="#_date2jul_keyword_DAY"></a>
150    <h4>DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156     
157     
158     
159    </h4>
160
161   
162 Set this keyword equal to a named variable that will receive a
163 longword integer or longword integer array representing the number of
164 the day of the month (1-31). 
165
166   
167    <a name="#_date2jul_keyword_YEAR"></a>
168    <h4>YEAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169     
170     
171     
172     
173     
174     
175     
176     
177    </h4>
178
179   
180 Set this keyword equal to a named variable that will receive a
181 longword integer or longword integer array representing the number of
182 the desired year (e.g., 1994). 
183
184   
185    <a name="#_date2jul_keyword_HOUR"></a>
186    <h4>HOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187     
188     
189     
190     
191     
192     
193     
194     
195    </h4>
196
197   
198 Set this keyword equal to a named variable that will receive a
199 longword integer or longword integer array representing the number of
200 the hour of the day (0-23). 
201 
202   
203    <a name="#_date2jul_keyword_MINUTE"></a>
204    <h4>MINUTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205     
206     
207     
208     
209     
210     
211     
212     
213    </h4>
214
215   
216 Set this keyword equal to a named variable that will receive a
217 longword integer or longword integer array representing the number of
218 the minute of the hour (0-59). 
219 
220   
221    <a name="#_date2jul_keyword_SECOND"></a>
222    <h4>SECOND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223     
224     
225     
226     
227     
228     
229     
230     
231    </h4>
232
233   
234 Set this keyword equal to a named variable that will receive a
235 double-precision floating-point value or a double-precision
236 floating-point array representing the number of the second of the
237 minute (0-59).
238
239   
240   
241
242    <h3>Examples</h3><pre>
243
244   IDL> jday = juldate(19930124)
245   IDL> print, date2jul(19931205) EQ julday(12,5,1993)
246       1
247   IDL> print, date2jul(931205,/grads) EQ julday(12,5,1993)
248       1
249   IDL> print, date2jul(19931205.5d) EQ julday(12,5,1993,12,0,0)
250       1
251   IDL> print, date2jul(19931205.0d) EQ julday(12,5,1993,0,0,0)
252       1
253
254    </pre><h3>Version history</h3>
255   
256    <h4>Version</h4>
257 $Id: date2jul.pro 371 2008-08-07 09:32:02Z pinsard $
258
259    <h4>History</h4>
260 Sebastien Masson (smasson@lodyc.jussieu.fr) June 2005
261
262   
263
264    <h3>Known issues</h3>
265   
266   
267   
268    <h4>Restrictions</h4>
269 Input param must be longword integer or double-precision floating-point
270 
271
272   
273   
274   
275   
276   
277   
278   
279
280    <font size="-3"><p>&nbsp;</p></font>
281    <hr size="1" color="#CCCCCC"/>
282     
283
284   
285
286    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
287
288  </body>
289</html>
Note: See TracBrowser for help on using the repository browser.