source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALENDRIER/julday.html @ 89

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 6.9 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="def_month.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="julday.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/CALENDRIER/</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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_JULDAY">
103
104          <h2><a class="top" href="#container">top</a>JULDAY </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:
111        JULDAY
112
113 PURPOSE:
114        Calculate the Julian Day Number for a given month, day, and year.
115        This is the inverse of the library function CALDAT.
116        See also caldat, the inverse of this function.
117
118 CATEGORY:
119        Misc.
120
121 CALLING SEQUENCE:
122        Result = JULDAY([[[[Month, Day, Year], Hour], Minute], Second])
123
124 INPUTS:
125        MONTH:  Number of the desired month (1 = January, ..., 12 = December).
126
127        DAY:    Number of day of the month.
128
129        YEAR:   Number of the desired year.Year parameters must be valid
130               values from the civil calendar.  Years B.C.E. are represented
131               as negative integers.  Years in the common era are represented
132               as positive integers.  In particular, note that there is no
133               year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
134               1 C.E. (1).
135
136        HOUR:   Number of the hour of the day.
137
138        MINUTE: Number of the minute of the hour.
139
140        SECOND: Number of the second of the minute.
141
142   Note: Month, Day, Year, Hour, Minute, and Second can all be arrays.
143         The Result will have the same dimensions as the smallest array, or
144         will be a scalar if all arguments are scalars.
145
146 OPTIONAL INPUT PARAMETERS:
147        Hour, Minute, Second = optional time of day.
148
149 KEYWORD PARAMETERS:
150
151       NDAYSPM: for using a calendar with fixed number of days per
152                months. defaut value of NDAYSPM=30
153
154 OUTPUTS:
155        JULDAY returns the Julian Day Number (which begins at noon) of the
156        specified calendar date.  If Hour, Minute, and Second are not specified,
157        then the result will be a long integer, otherwise the result is a
158        double precision floating point number.
159
160 COMMON BLOCKS: cm_4cal
161
162 SIDE EFFECTS:
163        None.
164
165 RESTRICTIONS:
166        Accuracy using IEEE double precision numbers is approximately
167   1/10000th of a second, with higher accuracy for smaller (earlier)
168   Julian dates.
169
170 MODIFICATION HISTORY:
171        Translated from "Numerical Recipies in C", by William H. Press,
172        Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
173        Cambridge University Press, 1988 (second printing).
174
175        AB, September, 1988
176        DMS, April, 1995, Added time of day.
177
178       Eric Guilyardi, June 1999
179       Added key_work ndayspm for fixed number of days per months
180       + change to accept year 0
181
182       Sebastien Masson, Aug. 2003
183       fix bug for negative and large values of month values
184       eg. julday(349,1,1970)
185
186   CT, April 2000, Now accepts vectors or scalars.</div>
187
188         
189
190         
191            <h3>Parameters</h3>
192       
193           
194            <h4 id="_JULDAY_param_MONTH">MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205          <div class="comments"></div>
206           
207            <h4 id="_JULDAY_param_DAY">DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218          <div class="comments"></div>
219           
220            <h4 id="_JULDAY_param_YEARin">YEARin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231          <div class="comments"></div>
232           
233            <h4 id="_JULDAY_param_Hour">Hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244          <div class="comments"></div>
245           
246            <h4 id="_JULDAY_param_Minute">Minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248             
249             
250             
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments"></div>
258           
259            <h4 id="_JULDAY_param_Second">Second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
260             
261             
262             
263             
264             
265             
266             
267             
268            </h4>
269       
270          <div class="comments"></div>
271           
272
273         
274
275         
276
277            <h3>Keywords</h3>
278           
279            <h4 id="_JULDAY_keyword_NDAYSPM">NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280             
281             
282             
283             
284             
285             
286             
287             
288            </h4>
289       
290            <div class="comments"></div>
291           
292         
293
294         
295         
296         
297         
298         
299         
300         
301         
302         
303         
304         
305         
306       
307         
308         
309         
310         
311         
312         
313         
314       
315         
316       
317        </div>
318       
319      </div>
320
321     
322
323      <div id="tagline">Produced by IDLdoc 2.0.</div>
324
325    </div>
326
327  </body>
328</html>
Note: See TracBrowser for help on using the repository browser.