source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/LABEL/label_date.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 7.8 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>label_date.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="label_date.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="../../../../../ToBeReviewed/PLOTS/LABEL//label_date.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="label.html">&lt;&lt;prev file</a> | <a href="label_gmt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="label_date.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">ToBeReviewed/PLOTS/LABEL/</a></h1>
82      <h2 class="pro_file">label_date.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 This function labels axes with dates and times.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_label_date">
105
106          <h2><a class="top" href="#container">top</a>label_date <span class="categories">
107 Plotting
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>label_date(<span class="result"><a href="#_label_date_param_axis">axis</a>, <a href="#_label_date_param_index">index</a>, <a href="#_label_date_param_x">x</a></span>, <a href="#_label_date_keyword_DATE_FORMAT">DATE_FORMAT</a>=<span class="result">DATE_FORMAT</span>, <a href="#_label_date_keyword_MONTHS">MONTHS</a>=<span class="result">MONTHS</span>, <a href="#_label_date_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_label_date_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_label_date_param_axis">axis&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134</div>
135           
136            <h4 id="_label_date_param_index">index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137              <span class="attr">in</span>
138             
139             
140              <span class="attr">required</span>
141             
142             
143             
144             
145            </h4>
146       
147          <div class="comments">
148</div>
149           
150            <h4 id="_label_date_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151              <span class="attr">in</span>
152             
153             
154              <span class="attr">required</span>
155             
156             
157             
158             
159            </h4>
160       
161          <div class="comments">
162</div>
163           
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
171            <h4 id="_label_date_keyword_DATE_FORMAT">DATE_FORMAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182            <div class="comments">
183 a format string which may contain the following:
184 %M for month (3 character abbr)
185 %N for month (2 digit abbr)
186 %D for day of month,
187 %Y for 4 digit year.
188 %Z for last two digits of year.
189  For time:
190 %H for Hours, 2 digits.
191 %I for Minutes, 2 digits.
192 %S for Seconds, 2 digits.
193 %% is %.
194  Other characters are passed directly thru.
195 For example, '%M %D, %Y' prints DEC 11, 1993
196 '%M %2Y' yields DEC 93
197 '%D-%M' yields 11-DEC
198 '%D/%N/%Y' yields 11/12/1993
199 '%M!C%Y' yields DEC on the top line, 1993 on
200 the bottom (!C is the new line graphic command).
201</div>
202           
203            <h4 id="_label_date_keyword_MONTHS">MONTHS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments">
215 The names of the months, a twelve element string array.
216 If omitted, use Jan, Feb, ..., Dec.
217</div>
218           
219            <h4 id="_label_date_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231 An optional starting offset of the plot.
232 Unfortunately, single precision floating point is not accurate
233 enough to properly represent Julian times.  This offset, which
234 may be double precision, contains an offset that is added to
235 all x values, before conversion to Julian date and time.
236</div>
237           
238            <h4 id="_label_date_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244             
245             
246             
247            </h4>
248       
249            <div class="comments"></div>
250           
251         
252
253          <h3>Examples</h3><div class="preformat">
254 For example, to plot from Jan 1, 1993, to July 12, 1994:
255 Start_date = julday(1, 1, 1993)
256 End_date = julday(7, 12, 1994)
257 Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')  ;Simple mm/dd
258 x = findgen(end_date+1 - start_date) + start_date ;Time axis
259 PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
260 (Plot with X axis style set to exact.)
261       
262 Example with times:
263        For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3,
264        1993:
265        Start_date = Julday(1,1,1993)   ;Also starting offset
266        Start_time = (3+12)/24.         ;Starting_time less offset
267        End_time = (Julday(1,3,1993) - Start_date) + 5./24. ;Ending
268        ;date/time - offset, note that the order of operations is
269               ; important to avoid loss of precision.
270        Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', $
271                offset=Start_date)       ;MMM NN <new line> HH:MM format
272        x = findgen(20) * (End_time - Start_time) / 19 + start_time ;Time axis
273        PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
274</div>
275          <h3>Version history</h3>
276         
277          <h4>Version</h4><div class="preformat">
278 $Id: label_date.pro 327 2007-12-13 16:22:35Z pinsard $
279</div>
280          <h4>History</h4><div class="preformat">
281        DMS, RSI.       April, 1993.    Written.
282        DMS, RSI.       March, 1997.    Added Time format.
283
284 Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
285        Unauthorized reproduction prohibited.
286</div>
287         
288         
289          <h3>Known issues</h3>
290         
291         
292         
293          <h4>Restrictions</h4><div class="preformat">
294 Only one date axis may be simultaneously active.
295</div>
296       
297          <h3>Other attributes</h3>
298         
299         
300          <h4>Uses routines</h4><div class="preformat">
301 LABEL_DATE_COM.
302</div>
303         
304         
305          <h4>Common blocks used</h4><div class="preformat">label_date_com</div>
306       
307          <h3>Statistics</h3>
308          <table class="statistics">
309            <tr><td>McCabe cyclic</td><td>          17</td></tr>
310            <tr><td>McCabe essential</td><td>           1</td></tr>
311            <tr><td>McCabe modular design</td><td>           1</td></tr>
312          </table>
313         
314       
315        </div>
316       
317      </div>
318
319     
320
321      <div id="tagline">Produced by IDLdoc 2.0.</div>
322
323    </div>
324
325  </body>
326</html>
Note: See TracBrowser for help on using the repository browser.