source: trunk/SRC/Documentation/idldoc_html_output/Calendar/caldat.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: 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>caldat.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="caldat.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//caldat.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&lt;&lt; prev file | <a href="date2jul.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="caldat.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">caldat.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Return the calendar date and time given julian date.
91 This is the inverse of the function JULDAY.
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="_caldat">
108
109          <h2><a class="top" href="#container">top</a>caldat <span class="categories"> Calendar
110</span></h2>
111       
112          <p class="header">
113            caldat<span class="result">, <a href="#_caldat_param_julian">julian</a>, <a href="#_caldat_param_month">month</a>, <a href="#_caldat_param_day">day</a>, <a href="#_caldat_param_year">year</a>, <a href="#_caldat_param_hour">hour</a>, <a href="#_caldat_param_minute">minute</a>, <a href="#_caldat_param_second">second</a></span>, <a href="#_caldat_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">NDAYSPM</span></p>
114       
115          <div class="comments">
116</div>
117
118         
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_caldat_param_julian">julian&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments"> 
136 contains the Julian Day Number (which begins at noon) of the
137 specified calendar date.  It should be a long integer.
138</div>
139           
140            <h4 id="_caldat_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141             
142              <span class="attr">out</span>
143             
144             
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments"> 
152 Number of the desired month (1 = January, ..., 12 = December).
153</div>
154           
155            <h4 id="_caldat_param_day">day&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156             
157              <span class="attr">out</span>
158             
159             
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments"> 
167 Number of day of the month.
168</div>
169           
170            <h4 id="_caldat_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171             
172              <span class="attr">out</span>
173             
174             
175             
176             
177             
178             
179            </h4>
180       
181          <div class="comments"> 
182 Number of the desired year.
183</div>
184           
185            <h4 id="_caldat_param_hour">hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187              <span class="attr">out</span>
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196          <div class="comments"> 
197 Hour of the day
198</div>
199           
200            <h4 id="_caldat_param_minute">minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202              <span class="attr">out</span>
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211          <div class="comments"> 
212 Minute of the day
213</div>
214           
215            <h4 id="_caldat_param_second">second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217              <span class="attr">out</span>
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226          <div class="comments"> 
227 Second (and fractions) of the day.
228</div>
229           
230
231         
232
233         
234
235            <h3>Keywords</h3>
236           
237            <h4 id="_caldat_keyword_NDAYSPM">NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244              <span class="attr">default:</span> <span class="value">30</span>
245             
246            </h4>
247       
248            <div class="comments"> 
249 To use a calendar with fixed number of days per months.
250 see also the use of key_caltype (variable of the common file cm_4cal)
251</div>
252           
253         
254
255         
256          <h3>Version history</h3>
257         
258          <h4>Version</h4><div class="preformat"> $Id: caldat.pro 163 2006-08-29 12:59:46Z navarro $</div>
259          <h4>History</h4><div class="preformat"> 
260 Translated from "Numerical Recipies in C", by William H. Press,
261 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
262 Cambridge University Press, 1988 (second printing).
263
264 DMS, July 1992.
265 DMS, April 1996, Added HOUR, MINUTE and SECOND keyword
266 AB, 7 December 1997, Generalized to handle array input.
267
268 Eric Guilyardi, June 1999
269 Added key_work ndayspm for fixed number of days per months
270
271 AB, 3 January 2000, Make seconds output as DOUBLE in array output.
272
273 Sebastien Masson, May 2006, add different calendat with key_caltype
274 (variable of the common file cm_4cal)
275</div>
276         
277         
278          <h3>Known issues</h3>
279         
280         
281         
282          <h4>Restrictions</h4><div class="preformat"> 
283 Accuracy using IEEE double precision numbers is approximately 1/10000th of a
284 second.
285</div>
286       
287          <h3>Other attributes</h3>
288         
289         
290          <h4>Uses routines</h4><div class="preformat"> cm_4cal
291</div>
292         
293         
294         
295       
296          <h3>Statistics</h3>
297          <table class="statistics">
298            <tr><td>McCabe cyclic</td><td>          22</td></tr>
299            <tr><td>McCabe essential</td><td>           1</td></tr>
300            <tr><td>McCabe modular design</td><td>           1</td></tr>
301          </table>
302         
303       
304        </div>
305       
306      </div>
307
308     
309
310      <div id="tagline">Produced by IDLdoc 2.0.</div>
311
312    </div>
313
314  </body>
315</html>
Note: See TracBrowser for help on using the repository browser.