source: trunk/SRC/Documentation/idldoc_assistant_output/Calendar/julday.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation
File size: 7.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>julday.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="jul2date.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="leapyr.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>julday.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Calculate the Julian Day Number for a given month, day, and year.
65 This is the inverse of the library function
66 <a href="..//Calendar/caldat.html">caldat</a>.
67 3 calendars are available according to the value of key_caltype
68 (variable of the common file cm_4cal): 'greg', '360d', 'noleap'
69
70
71   
72
73     
74      <a name="#_julday"></a>
75
76      <h2>julday  <font size="-1" color="#006633">
77 Calendar
78</font></h2>
79
80      <p><font face="Courier"><i>result = </i>julday(<i><a href="#_julday_keyword_month">month</a>, <a href="#_julday_keyword_day">day</a>, <a href="#_julday_keyword_yearin">yearin</a>[, <a href="#_julday_keyword_hour">hour</a>][, <a href="#_julday_keyword_minute">minute</a>][, <a href="#_julday_keyword_second">second</a>]</i>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<i>integer</i>)</font></p>
81
82   
83
84
85    <h3>Return value</h3>
86 the Julian Day Number (which begins at noon) of the specified calendar date.
87 If Hour, Minute, and Second are not specified, then the result will be a
88 long integer, otherwise the result is a double precision floating point
89 number.
90
91
92   
93    <h3>Parameters</h3>
94   
95
96    <a name="#_julday_keyword_month"></a>
97    <h4>month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
98      <font size="-1" color="#006633">in</font>
99     
100     
101      <font size="-1" color="#006633">required</font>
102     
103      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
104     
105     
106    </h4>
107
108   
109 Number of the desired month (1 = January, ..., 12 = December).
110
111   
112
113    <a name="#_julday_keyword_day"></a>
114    <h4>day&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115      <font size="-1" color="#006633">in</font>
116     
117     
118      <font size="-1" color="#006633">required</font>
119     
120      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
121     
122     
123    </h4>
124
125   
126 Number of day of the month.
127
128   
129
130    <a name="#_julday_keyword_yearin"></a>
131    <h4>yearin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132      <font size="-1" color="#006633">in</font>
133     
134     
135      <font size="-1" color="#006633">required</font>
136     
137      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
138     
139     
140    </h4>
141
142   
143 Number of the desired year.Year parameters must be valid
144 values from the civil calendar.  Years B.C.E. are represented
145 as negative integers. Years in the common era are represented
146 as positive integers. In particular, note that there is no
147 year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
148 1 C.E. (1).
149 Change: However for climatological year, we do accept the year
150 0 but we change it for year 654321L (the same trick is done in
151 <a href="..//Calendar/caldat.html">caldat</a> so caldat, julday(1,1,0) gives you back Jan 1st of year 0)
152
153   
154
155    <a name="#_julday_keyword_hour"></a>
156    <h4>hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157      <font size="-1" color="#006633">in</font>
158     
159      <font size="-1" color="#006633">optional</font>
160     
161     
162      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
163      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>12</i></font>
164     
165    </h4>
166
167   
168 Number of the hour of the day.
169
170   
171
172    <a name="#_julday_keyword_minute"></a>
173    <h4>minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174      <font size="-1" color="#006633">in</font>
175     
176      <font size="-1" color="#006633">optional</font>
177     
178     
179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
180      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
181     
182    </h4>
183
184   
185 Number of the minute of the hour.
186
187   
188
189    <a name="#_julday_keyword_second"></a>
190    <h4>second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191      <font size="-1" color="#006633">in</font>
192     
193      <font size="-1" color="#006633">optional</font>
194     
195     
196      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (integer or double) or array of scalars</i></font>
197      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
198     
199    </h4>
200
201   
202 Number of the second of the minute.
203
204   
205   
206
207   
208    <h3>Keywords</h3>
209
210   
211    <a name="#_julday_keyword_NDAYSPM"></a>
212    <h4>NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213     
214     
215     
216     
217     
218      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
219      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>30</i></font>
220     
221    </h4>
222
223   
224 To use a calendar with fixed number of days per month.
225 see also the use of key_caltype (variable of the common file cm_4cal)
226
227   
228   
229
230   
231    </pre><h3>Version history</h3>
232   
233    <h4>Version</h4>
234 $Id: julday.pro 279 2007-09-07 13:40:51Z smasson $
235    <h4>History</h4>
236 Translated from "Numerical Recipies in C", by William H. Press,
237 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
238 Cambridge University Press, 1988 (second printing).
239
240 AB, September, 1988
241 DMS, April, 1995, Added time of day.
242
243 Eric Guilyardi, June 1999
244 Added key_work ndayspm for fixed number of days per months
245
246 CT, April 2000, Now accepts vectors or scalars.
247
248 Sebastien Masson, Aug. 2003
249 fix bug for negative and large values of month values
250 eg. julday(349,1,1970)
251
252 Sebastien Masson, May 2006, add different calendat with key_caltype
253 (variable of the common file cm_4cal)
254
255   
256
257    <h3>Known issues</h3>
258   
259   
260   
261    <h4>Restrictions</h4>
262 The result will have the same dimensions as the smallest array, or
263 will be a scalar if all arguments are scalars.
264
265
266 Accuracy using IEEE double precision numbers is approximately
267 1/10000th of a second, with higher accuracy for smaller (earlier)
268 Julian dates.
269
270
271    <h3>Other attributes</h3>
272   
273   
274    <h4>Uses routines</h4>
275 cm_4cal
276
277   
278   
279   
280
281    <font size="-3"><p>&nbsp;</p></font>
282    <hr size="1" color="#CCCCCC"/>
283     
284
285   
286
287    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
288
289  </body>
290</html>
Note: See TracBrowser for help on using the repository browser.