source: trunk/SRC/Documentation/idldoc_html_output/Calendar/jul2date.html @ 402

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

update documentation
File size: 7.3 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>jul2date.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="jul2date.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//jul2date.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="daysinmonth.html">&lt;&lt;prev file</a> | <a href="julday.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="jul2date.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">jul2date.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 gives yyyymmdd date equivalent of a Julian day
91 This is the inverse of the function <a href="..//Calendar/date2jul.html">date2jul</a>.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_jul2date">
106
107          <h2><a class="top" href="#container">top</a>jul2date <span class="categories">
108 Calendar
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>jul2date(<span class="result"><a href="#_jul2date_param_jday">jday</a></span>, <a href="#_jul2date_keyword_MONTH">MONTH</a>=<span class="result">MONTH</span>, <a href="#_jul2date_keyword_DAY">DAY</a>=<span class="result">DAY</span>, <a href="#_jul2date_keyword_YEAR">YEAR</a>=<span class="result">YEAR</span>, <a href="#_jul2date_keyword_HOUR">HOUR</a>=<span class="result">HOUR</span>, <a href="#_jul2date_keyword_MINUTE">MINUTE</a>=<span class="result">MINUTE</span>, <a href="#_jul2date_keyword_SECOND">SECOND</a>=<span class="result">SECOND</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 the date: longword integer with yyyymmdd format or double-precision
119 floating-point with yyyymmdd.xx where xx is the fraction of the day
120 (xx=0 at 0am and 5 at 12am)
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_jul2date_param_jday">jday&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133              <span class="attr">type:</span> <span class="value">long or double, scalar or array</span>
134             
135             
136            </h4>
137       
138          <div class="comments">
139 Julian day
140</div>
141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_jul2date_keyword_MONTH">MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160            <div class="comments">
161 Set this keyword equal to a named variable that will receive a
162 longword integer or longword integer array representing the number of
163 the desired month (1 = January, ..., 12 = December).
164</div>
165           
166            <h4 id="_jul2date_keyword_DAY">DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167             
168             
169             
170             
171             
172             
173             
174             
175            </h4>
176       
177            <div class="comments">
178 Set this keyword equal to a named variable that will receive a
179 longword integer or longword integer array representing the number of
180 the day of the month (1-31). 
181</div>
182           
183            <h4 id="_jul2date_keyword_YEAR">YEAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185             
186             
187             
188             
189             
190             
191             
192            </h4>
193       
194            <div class="comments">
195 Set this keyword equal to a named variable that will receive a
196 longword integer or longword integer array representing the number of
197 the desired year (e.g., 1994). 
198</div>
199           
200            <h4 id="_jul2date_keyword_HOUR">HOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments">
212 Set this keyword equal to a named variable that will receive a
213 longword integer or longword integer array representing the number of
214 the hour of the day (0-23). 
215 </div>
216           
217            <h4 id="_jul2date_keyword_MINUTE">MINUTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223             
224             
225             
226            </h4>
227       
228            <div class="comments">
229 Set this keyword equal to a named variable that will receive a
230 longword integer or longword integer array representing the number of
231 the minute of the hour (0-59). 
232  </div>
233           
234            <h4 id="_jul2date_keyword_SECOND">SECOND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
240             
241             
242             
243            </h4>
244       
245            <div class="comments">
246 Set this keyword equal to a named variable that will receive a
247 double-precision floating-point value or a double-precision
248 floating-point array representing the number of the second of the
249 minute (0-59).
250</div>
251           
252         
253
254          <h3>Examples</h3><div class="preformat">
255
256   IDL> print, jul2date(julday(12,23,1999))
257     19991223
258   IDL> print, jul2date(julday(12,23,1999,12,0,0))
259        19991224.
260   IDL> print, jul2date(julday(12,23,1999,12,0,0)), format='(f11.2)'
261 19991223.50
262   IDL> print, jul2date(julday(12,23,1999,0,0,0)), format='(f11.2)'
263 19991223.00
264</div>
265          <h3>Version history</h3>
266         
267          <h4>Version</h4><div class="preformat">
268 $Id: jul2date.pro 371 2008-08-07 09:32:02Z pinsard $
269</div>
270          <h4>History</h4><div class="preformat">
271 Sebastien Masson (smasson@lodyc.jussieu.fr)
272                       June 2005
273</div>
274         
275         
276          <h3>Known issues</h3>
277         
278         
279         
280          <h4>Restrictions</h4><div class="preformat">
281 Input param must be longword integer or double-precision floating-point
282 </div>
283       
284         
285         
286         
287         
288         
289         
290         
291       
292          <h3>Statistics</h3>
293          <table class="statistics">
294            <tr><td>McCabe cyclic</td><td>           3</td></tr>
295            <tr><td>McCabe essential</td><td>           1</td></tr>
296            <tr><td>McCabe modular design</td><td>           1</td></tr>
297          </table>
298         
299       
300        </div>
301       
302      </div>
303
304     
305
306      <div id="tagline">Produced by IDLdoc 2.0.</div>
307
308    </div>
309
310  </body>
311</html>
Note: See TracBrowser for help on using the repository browser.