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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

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