source: trunk/SRC/Documentation/idldoc_html_output/Calendar/julday.html @ 191

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 8.0 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>julday.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="julday.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Calendar//julday.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="jul2date.html">&lt;&lt;prev file</a> | <a href="leapyr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="julday.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Calendar/</a></h1>
82      <h2 class="pro_file">julday.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Calculate the Julian Day Number for a given month, day, and year.
91 This is the inverse of the library function CALDAT.
92 3 calendars are available according to the value of key_caltype
93 (variable of the common file cm_4cal): 'greg', '360d', 'noleap'
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_julday">
108
109          <h2><a class="top" href="#container">top</a>julday <span class="categories"> Calendar
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>julday(<span class="result"><a href="#_julday_param_MONTH">MONTH</a>, <a href="#_julday_param_DAY">DAY</a>, <a href="#_julday_param_YEARin">YEARin</a>[, <a href="#_julday_param_Hour">Hour</a>][, <a href="#_julday_param_Minute">Minute</a>][, <a href="#_julday_param_Second">Second</a>]</span>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">NDAYSPM</span>)</p>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat"> 
119 the Julian Day Number (which begins at noon) of the specified calendar date.
120 If Hour, Minute, and Second are not specified, then the result will be a
121 long integer, otherwise the result is a double precision floating point
122 number.
123</div>
124
125         
126            <h3>Parameters</h3>
127       
128           
129            <h4 id="_julday_param_MONTH">MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130              <span class="attr">in</span>
131             
132             
133              <span class="attr">required</span>
134             
135             
136             
137             
138            </h4>
139       
140          <div class="comments"> 
141 Number of the desired month (1 = January, ..., 12 = December).
142 Can be scalar or array
143</div>
144           
145            <h4 id="_julday_param_DAY">DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146              <span class="attr">in</span>
147             
148             
149              <span class="attr">required</span>
150             
151             
152             
153             
154            </h4>
155       
156          <div class="comments"> 
157 Number of day of the month.Can be scalar or array
158</div>
159           
160            <h4 id="_julday_param_YEARin">YEARin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161              <span class="attr">in</span>
162             
163             
164              <span class="attr">required</span>
165             
166             
167             
168             
169            </h4>
170       
171          <div class="comments"> 
172 Number of the desired year.Year parameters must be valid
173 values from the civil calendar.  Years B.C.E. are represented
174 as negative integers. Years in the common era are represented
175 as positive integers. In particular, note that there is no
176 year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
177 1 C.E. (1).
178 Change: However for climatological year, we do accept the year
179 O but we change it for year 654321L (the same trick is done in
180 caldat so caldat, julday(1,1,0) gives you back Jan 1st of year 0)
181 Can be scalar or array
182</div>
183           
184            <h4 id="_julday_param_Hour">Hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185              <span class="attr">in</span>
186             
187              <span class="attr">optional</span>
188             
189             
190             
191              <span class="attr">default:</span> <span class="value">12</span>
192             
193            </h4>
194       
195          <div class="comments"> 
196 Number of the hour of the day. Can be scalar or array
197</div>
198           
199            <h4 id="_julday_param_Minute">Minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200              <span class="attr">in</span>
201             
202              <span class="attr">optional</span>
203             
204             
205             
206              <span class="attr">default:</span> <span class="value">0</span>
207             
208            </h4>
209       
210          <div class="comments">
211 Number of the minute of the hour. Can be scalar or array
212</div>
213           
214            <h4 id="_julday_param_Second">Second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215              <span class="attr">in</span>
216             
217              <span class="attr">optional</span>
218             
219             
220             
221              <span class="attr">default:</span> <span class="value">0</span>
222             
223            </h4>
224       
225          <div class="comments">
226 Number of the second of the minute. Can be scalar or array
227</div>
228           
229
230         
231
232         
233
234            <h3>Keywords</h3>
235           
236            <h4 id="_julday_keyword_NDAYSPM">NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243              <span class="attr">default:</span> <span class="value">30</span>
244             
245            </h4>
246       
247            <div class="comments"> 
248 To use a calendar with fixed number of days per months.
249 see also the use of key_caltype (variable of the common file cm_4cal)
250</div>
251           
252         
253
254         
255          <h3>Version history</h3>
256         
257          <h4>Version</h4><div class="preformat"> $Id: julday.pro 163 2006-08-29 12:59:46Z navarro $</div>
258          <h4>History</h4><div class="preformat"> 
259 Translated from "Numerical Recipies in C", by William H. Press,
260 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
261 Cambridge University Press, 1988 (second printing).
262
263 AB, September, 1988
264 DMS, April, 1995, Added time of day.
265
266 Eric Guilyardi, June 1999
267 Added key_work ndayspm for fixed number of days per months
268
269 CT, April 2000, Now accepts vectors or scalars.
270
271 Sebastien Masson, Aug. 2003
272 fix bug for negative and large values of month values
273 eg. julday(349,1,1970)
274
275 Sebastien Masson, May 2006, add diferent calendat with key_caltype
276 (variable of the common file cm_4cal)
277</div>
278         
279         
280          <h3>Known issues</h3>
281         
282         
283         
284          <h4>Restrictions</h4><div class="preformat"> 
285 The Result will have the same dimensions as the smallest array, or
286 will be a scalar if all arguments are scalars.
287 
288 
289 Accuracy using IEEE double precision numbers is approximately
290 1/10000th of a second, with higher accuracy for smaller (earlier)
291 Julian dates.
292</div>
293       
294          <h3>Other attributes</h3>
295         
296         
297          <h4>Uses routines</h4><div class="preformat"> cm_4cal
298</div>
299         
300         
301         
302       
303          <h3>Statistics</h3>
304          <table class="statistics">
305            <tr><td>McCabe cyclic</td><td>          38</td></tr>
306            <tr><td>McCabe essential</td><td>           1</td></tr>
307            <tr><td>McCabe modular design</td><td>           1</td></tr>
308          </table>
309         
310       
311        </div>
312       
313      </div>
314
315     
316
317      <div id="tagline">Produced by IDLdoc 2.0.</div>
318
319    </div>
320
321  </body>
322</html>
Note: See TracBrowser for help on using the repository browser.