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

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

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