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

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

update documentation

File size: 7.7 KB
RevLine 
[89]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>
[104]9    <title>date2jul.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="date2jul.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Calendar//date2jul.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="caldat.html">&lt;&lt;prev file</a> | <a href="date2string.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="date2jul.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Calendar/</a></h1>
[89]82      <h2 class="pro_file">date2jul.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[242]89      <div id="file_comments">
[321]90 gives Julian day equivalent of a date given in yyyymmdd format
91 This is the inverse of the function <a href="..//Calendar/jul2date.html">jul2date</a>.
[97]92</div>
[89]93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_date2jul">
106
[157]107          <h2><a class="top" href="#container">top</a>date2jul <span class="categories">
108 Calendar
[93]109</span></h2>
[89]110       
111          <p class="header">
[290]112            <span class="result">result = </span>date2jul(<span class="result"><a href="#_date2jul_param_date">date</a></span>, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<span class="result">GRADS</span>, <a href="#_date2jul_keyword_MONTH">MONTH</a>=<span class="result">MONTH</span>, <a href="#_date2jul_keyword_DAY">DAY</a>=<span class="result">DAY</span>, <a href="#_date2jul_keyword_YEAR">YEAR</a>=<span class="result">YEAR</span>, <a href="#_date2jul_keyword_HOUR">HOUR</a>=<span class="result">HOUR</span>, <a href="#_date2jul_keyword_MINUTE">MINUTE</a>=<span class="result">MINUTE</span>, <a href="#_date2jul_keyword_SECOND">SECOND</a>=<span class="result">SECOND</span>)</p>
[89]113       
114          <div class="comments">
[93]115</div>
[89]116
[242]117          <h3>Return value</h3><div class="preformat">
[290]118 Julian day with the same format (long or double) as the input parameter
[89]119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_date2jul_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]126              <span class="attr">in</span>
[89]127             
128             
[93]129              <span class="attr">required</span>
[89]130             
[321]131              <span class="attr">type:</span> <span class="value">long or double, scalar or array</span>
[89]132             
133             
134            </h4>
135       
[234]136          <div class="comments">
[290]137 longword integer with yyyymmdd format or double-precision
138 floating-point with yyyymmdd.xx where xx is the fraction of the day
139 (xx=0 at 0am and 5 at 12am)
[93]140</div>
[89]141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_date2jul_keyword_GRADS">GRADS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
[138]151             
152             
[89]153             
154             
155             
156             
157             
158            </h4>
159       
[138]160            <div class="comments">
161 if  1 <= year <= 49 --> year = 2000 + year
162 if 50 <= year <= 99 --> year = 1900 + year
[93]163</div>
[89]164           
[290]165            <h4 id="_date2jul_keyword_MONTH">MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177 Set this keyword equal to a named variable that will receive a
178 longword integer or longword integer array representing the number of
179 the desired month (1 = January, ..., 12 = December).
180</div>
181           
182            <h4 id="_date2jul_keyword_DAY">DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189             
190             
191            </h4>
192       
193            <div class="comments">
194 Set this keyword equal to a named variable that will receive a
195 longword integer or longword integer array representing the number of
196 the day of the month (1-31). 
197</div>
198           
199            <h4 id="_date2jul_keyword_YEAR">YEAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205             
206             
207             
208            </h4>
209       
210            <div class="comments">
211 Set this keyword equal to a named variable that will receive a
212 longword integer or longword integer array representing the number of
213 the desired year (e.g., 1994). 
214</div>
215           
216            <h4 id="_date2jul_keyword_HOUR">HOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218             
219             
220             
221             
222             
223             
224             
225            </h4>
226       
227            <div class="comments">
228 Set this keyword equal to a named variable that will receive a
229 longword integer or longword integer array representing the number of
230 the hour of the day (0-23). 
231 </div>
232           
233            <h4 id="_date2jul_keyword_MINUTE">MINUTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244            <div class="comments">
245 Set this keyword equal to a named variable that will receive a
246 longword integer or longword integer array representing the number of
247 the minute of the hour (0-59). 
248  </div>
249           
250            <h4 id="_date2jul_keyword_SECOND">SECOND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256             
257             
258             
259            </h4>
260       
261            <div class="comments">
262 Set this keyword equal to a named variable that will receive a
263 double-precision floating-point value or a double-precision
264 floating-point array representing the number of the second of the
265 minute (0-59).
266</div>
267           
[89]268         
269
[138]270          <h3>Examples</h3><div class="preformat">
[93]271
[402]272   IDL> jday = juldate(19930124)
273   IDL> print, date2jul(19931205) EQ julday(12,5,1993)
[93]274       1
[402]275   IDL> print, date2jul(931205,/grads) EQ julday(12,5,1993)
[93]276       1
[402]277   IDL> print, date2jul(19931205.5d) EQ julday(12,5,1993,12,0,0)
[290]278       1
[402]279   IDL> print, date2jul(19931205.0d) EQ julday(12,5,1993,0,0,0)
[290]280       1
[93]281</div>
282          <h3>Version history</h3>
[89]283         
[234]284          <h4>Version</h4><div class="preformat">
[402]285 $Id: date2jul.pro 371 2008-08-07 09:32:02Z pinsard $
[118]286</div>
[242]287          <h4>History</h4><div class="preformat">
[138]288 Sebastien Masson (smasson@lodyc.jussieu.fr) June 2005
[118]289</div>
[89]290         
291         
[290]292          <h3>Known issues</h3>
[89]293         
294         
295         
[290]296          <h4>Restrictions</h4><div class="preformat">
297 Input param must be longword integer or double-precision floating-point
298 </div>
[89]299       
300         
301         
302         
303         
304         
305         
306         
307       
[163]308          <h3>Statistics</h3>
309          <table class="statistics">
[338]310            <tr><td>McCabe cyclic</td><td>           5</td></tr>
[163]311            <tr><td>McCabe essential</td><td>           1</td></tr>
312            <tr><td>McCabe modular design</td><td>           1</td></tr>
313          </table>
[89]314         
315       
316        </div>
317       
318      </div>
319
320     
321
322      <div id="tagline">Produced by IDLdoc 2.0.</div>
323
324    </div>
325
326  </body>
[249]327</html>
Note: See TracBrowser for help on using the repository browser.