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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 7.0 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 CALDAT.
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="#_julday"></a>
74
75      <h2>julday  <font size="-1" color="#006633"> Calendar
76</font></h2>
77
78      <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>NDAYSPM</i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3> 
84 the Julian Day Number (which begins at noon) of the specified calendar date.
85 If Hour, Minute, and Second are not specified, then the result will be a
86 long integer, otherwise the result is a double precision floating point
87 number.
88
89
90   
91    <h3>Parameters</h3>
92   
93
94    <a name="#_julday_keyword_MONTH"></a>
95    <h4>MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
96      <font size="-1" color="#006633">in</font>
97     
98     
99      <font size="-1" color="#006633">required</font>
100     
101     
102     
103     
104    </h4>
105
106     
107 Number of the desired month (1 = January, ..., 12 = December).
108 Can be scalar or array
109
110   
111
112    <a name="#_julday_keyword_DAY"></a>
113    <h4>DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114      <font size="-1" color="#006633">in</font>
115     
116     
117      <font size="-1" color="#006633">required</font>
118     
119     
120     
121     
122    </h4>
123
124     
125 Number of day of the month.Can be scalar or array
126
127   
128
129    <a name="#_julday_keyword_YEARin"></a>
130    <h4>YEARin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131      <font size="-1" color="#006633">in</font>
132     
133     
134      <font size="-1" color="#006633">required</font>
135     
136     
137     
138     
139    </h4>
140
141     
142 Number of the desired year.Year parameters must be valid
143 values from the civil calendar.  Years B.C.E. are represented
144 as negative integers. Years in the common era are represented
145 as positive integers. In particular, note that there is no
146 year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
147 1 C.E. (1).
148 Change: However for climatological year, we do accept the year
149 O but we change it for year 654321L (the same trick is done in
150 caldat so caldat, julday(1,1,0) gives you back Jan 1st of year 0)
151 Can be scalar or array
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     
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. Can be scalar or array
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     
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. Can be scalar or array
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     
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. Can be scalar or array
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     
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 months.
225 see also the use of key_caltype (variable of the common file cm_4cal)
226
227   
228   
229
230   
231    <h3>Version history</h3>
232   
233    <h4>Version</h4> $Id: julday.pro 137 2006-07-12 09:33:44Z smasson $
234    <h4>History</h4> 
235 Translated from "Numerical Recipies in C", by William H. Press,
236 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
237 Cambridge University Press, 1988 (second printing).
238
239 AB, September, 1988
240 DMS, April, 1995, Added time of day.
241
242 Eric Guilyardi, June 1999
243 Added key_work ndayspm for fixed number of days per months
244
245 CT, April 2000, Now accepts vectors or scalars.
246
247 Sebastien Masson, Aug. 2003
248 fix bug for negative and large values of month values
249 eg. julday(349,1,1970)
250
251 Sebastien Masson, May 2006, add diferent 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 The Result will have the same dimensions as the smallest array, or
262 will be a scalar if all arguments are scalars.
263 
264 
265 Accuracy using IEEE double precision numbers is approximately
266 1/10000th of a second, with higher accuracy for smaller (earlier)
267 Julian dates.
268
269
270    <h3>Other attributes</h3>
271   
272   
273    <h4>Uses routines</h4> cm_4cal
274
275   
276   
277   
278
279    <font size="-3"><p>&nbsp;</p></font>
280    <hr size="1" color="#CCCCCC"/>
281     
282
283   
284
285    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:05 2006.</font></p>
286
287  </body>
288</html>
Note: See TracBrowser for help on using the repository browser.