source: trunk/SRC/Documentation/idldoc_assistant_output/Calendar/caldat.html @ 189

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

introducing hyperlinks in idldoc outputs (2/2)
File size: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>caldat.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="date2jul.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>caldat.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Return the calendar date and time given julian date.
65 This is the inverse of the function JULDAY.
66 3 calendars are available according to the value of key_caltype
67 (variable of the common file cm_4cal): 'greg', '360d', 'noleap'
68
69
70   
71
72     
73      <a name="#_caldat"></a>
74
75      <h2>caldat  <font size="-1" color="#006633"> Calendar
76</font></h2>
77
78      <p><font face="Courier">caldat<i>, <a href="#_caldat_keyword_julian">julian</a>, <a href="#_caldat_keyword_month">month</a>, <a href="#_caldat_keyword_day">day</a>, <a href="#_caldat_keyword_year">year</a>, <a href="#_caldat_keyword_hour">hour</a>, <a href="#_caldat_keyword_minute">minute</a>, <a href="#_caldat_keyword_second">second</a></i>, <a href="#_caldat_keyword_NDAYSPM">NDAYSPM</a>=<i>NDAYSPM</i></font></p>
79
80   
81
82
83   
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_caldat_keyword_julian"></a>
90    <h4>julian&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 contains the Julian Day Number (which begins at noon) of the
103 specified calendar date.  It should be a long integer.
104
105   
106
107    <a name="#_caldat_keyword_month"></a>
108    <h4>month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109     
110      <font size="-1" color="#006633">out</font>
111     
112     
113     
114     
115     
116     
117    </h4>
118
119     
120 Number of the desired month (1 = January, ..., 12 = December).
121
122   
123
124    <a name="#_caldat_keyword_day"></a>
125    <h4>day&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126     
127      <font size="-1" color="#006633">out</font>
128     
129     
130     
131     
132     
133     
134    </h4>
135
136     
137 Number of day of the month.
138
139   
140
141    <a name="#_caldat_keyword_year"></a>
142    <h4>year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143     
144      <font size="-1" color="#006633">out</font>
145     
146     
147     
148     
149     
150     
151    </h4>
152
153     
154 Number of the desired year.
155
156   
157
158    <a name="#_caldat_keyword_hour"></a>
159    <h4>hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160     
161      <font size="-1" color="#006633">out</font>
162     
163     
164     
165     
166     
167     
168    </h4>
169
170     
171 Hour of the day
172
173   
174
175    <a name="#_caldat_keyword_minute"></a>
176    <h4>minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178      <font size="-1" color="#006633">out</font>
179     
180     
181     
182     
183     
184     
185    </h4>
186
187     
188 Minute of the day
189
190   
191
192    <a name="#_caldat_keyword_second"></a>
193    <h4>second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195      <font size="-1" color="#006633">out</font>
196     
197     
198     
199     
200     
201     
202    </h4>
203
204     
205 Second (and fractions) of the day.
206
207   
208   
209
210   
211    <h3>Keywords</h3>
212
213   
214    <a name="#_caldat_keyword_NDAYSPM"></a>
215    <h4>NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216     
217     
218     
219     
220     
221     
222      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>30</i></font>
223     
224    </h4>
225
226     
227 To use a calendar with fixed number of days per months.
228 see also the use of key_caltype (variable of the common file cm_4cal)
229
230   
231   
232
233   
234    <h3>Version history</h3>
235   
236    <h4>Version</h4> $Id: caldat.pro 163 2006-08-29 12:59:46Z navarro $
237    <h4>History</h4> 
238 Translated from "Numerical Recipies in C", by William H. Press,
239 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
240 Cambridge University Press, 1988 (second printing).
241
242 DMS, July 1992.
243 DMS, April 1996, Added HOUR, MINUTE and SECOND keyword
244 AB, 7 December 1997, Generalized to handle array input.
245
246 Eric Guilyardi, June 1999
247 Added key_work ndayspm for fixed number of days per months
248
249 AB, 3 January 2000, Make seconds output as DOUBLE in array output.
250
251 Sebastien Masson, May 2006, add different calendat with key_caltype
252 (variable of the common file cm_4cal)
253
254   
255
256    <h3>Known issues</h3>
257   
258   
259   
260    <h4>Restrictions</h4> 
261 Accuracy using IEEE double precision numbers is approximately 1/10000th of a
262 second.
263
264
265    <h3>Other attributes</h3>
266   
267   
268    <h4>Uses routines</h4> cm_4cal
269
270   
271   
272   
273
274    <font size="-3"><p>&nbsp;</p></font>
275    <hr size="1" color="#CCCCCC"/>
276     
277
278   
279
280    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
281
282  </body>
283</html>
Note: See TracBrowser for help on using the repository browser.