source: trunk/SRC/Documentation/idldoc_html_output/Calendar/caldat.html

Last change on this file was 402, checked in by smasson, 15 years ago

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