| 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 (IDLdoc API 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 (IDLdoc API documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td >Source</td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | <td >Etc</td> |
|---|
| 65 | |
|---|
| 66 | <td id="flexible">Developer documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | <a href="label.html"><<prev file</a> | <a href="label_gmt.html">next file >></a> <a href="label_date.html" target="_TOP">view single page</a> | <a href="./../../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine 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?format=raw">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"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | <div id="routine_details"> |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div class="routine_details" id="_LABEL_DATE"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>LABEL_DATE </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | <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> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: |
|---|
| 111 | LABEL_DATE |
|---|
| 112 | |
|---|
| 113 | PURPOSE: |
|---|
| 114 | This function labels axes with dates and times. |
|---|
| 115 | |
|---|
| 116 | CATEGORY: |
|---|
| 117 | Plotting. |
|---|
| 118 | |
|---|
| 119 | CALLING SEQUENCE: |
|---|
| 120 | To set up: |
|---|
| 121 | dummy = LABEL_DATE(DATE_FORMAT='string') |
|---|
| 122 | To use: |
|---|
| 123 | PLOT, x, y, XTICKFORMAT='LABEL_DATE' |
|---|
| 124 | |
|---|
| 125 | INPUTS: |
|---|
| 126 | No explicit user defined inputs. When called from the plotting |
|---|
| 127 | routines, the input parameters are (Axis, Index, Value) |
|---|
| 128 | |
|---|
| 129 | KEYWORD PARAMETERS: |
|---|
| 130 | DATE_FORMAT: a format string which may contain the following: |
|---|
| 131 | %M for month (3 character abbr) |
|---|
| 132 | %N for month (2 digit abbr) |
|---|
| 133 | %D for day of month, |
|---|
| 134 | %Y for 4 digit year. |
|---|
| 135 | %Z for last two digits of year. |
|---|
| 136 | For time: |
|---|
| 137 | %H for Hours, 2 digits. |
|---|
| 138 | %I for mInutes, 2 digits. |
|---|
| 139 | %S for Seconds, 2 digits. |
|---|
| 140 | %% is %. |
|---|
| 141 | Other characters are passed directly thru. |
|---|
| 142 | For example, '%M %D, %Y' prints DEC 11, 1993 |
|---|
| 143 | '%M %2Y' yields DEC 93 |
|---|
| 144 | '%D-%M' yields 11-DEC |
|---|
| 145 | '%D/%N/%Y' yields 11/12/1993 |
|---|
| 146 | '%M!C%Y' yields DEC on the top line, 1993 on |
|---|
| 147 | the bottom (!C is the new line graphic command). |
|---|
| 148 | |
|---|
| 149 | MONTHS: The names of the months, a twelve element string array. |
|---|
| 150 | If omitted, use Jan, Feb, ..., Dec. |
|---|
| 151 | |
|---|
| 152 | OFFSET: An optional starting offset of the plot. |
|---|
| 153 | Unfortunately, single precision floating point is not accurate |
|---|
| 154 | enough to properly represent Julian times. This offset, which |
|---|
| 155 | may be double precision, contains an offset that is added to |
|---|
| 156 | all x values, before conversion to Julian date and time. |
|---|
| 157 | |
|---|
| 158 | OUTPUTS: |
|---|
| 159 | The date string to be plotted. |
|---|
| 160 | |
|---|
| 161 | COMMON BLOCKS: |
|---|
| 162 | LABEL_DATE_COM. |
|---|
| 163 | |
|---|
| 164 | RESTRICTIONS: |
|---|
| 165 | Only one date axis may be simultaneously active. |
|---|
| 166 | |
|---|
| 167 | PROCEDURE: |
|---|
| 168 | Straightforward. |
|---|
| 169 | |
|---|
| 170 | For an alternative way to label a plot axis with dates, refer to |
|---|
| 171 | the C() format code accepted within format strings (applicable via |
|---|
| 172 | the [XYZ]TICKFORMAT keywords). This new format code was |
|---|
| 173 | introduced in IDL 5.2. |
|---|
| 174 | |
|---|
| 175 | EXAMPLE: |
|---|
| 176 | For example, to plot from Jan 1, 1993, to July 12, 1994: |
|---|
| 177 | Start_date = julday(1, 1, 1993) |
|---|
| 178 | End_date = julday(7, 12, 1994) |
|---|
| 179 | Dummy = LABEL_DATE(DATE_FORMAT='%N/%D') ;Simple mm/dd |
|---|
| 180 | x = findgen(end_date+1 - start_date) + start_date ;Time axis |
|---|
| 181 | PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1 |
|---|
| 182 | (Plot with X axis style set to exact.) |
|---|
| 183 | |
|---|
| 184 | Example with times: |
|---|
| 185 | For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3, |
|---|
| 186 | 1993: |
|---|
| 187 | Start_date = Julday(1,1,1993) ;Also starting offset |
|---|
| 188 | Start_time = (3+12)/24. ;Starting_time less offset |
|---|
| 189 | End_time = (Julday(1,3,1993) - Start_date) + 5./24. ;Ending |
|---|
| 190 | ;date/time - offset, note that the order of operations is |
|---|
| 191 | ; important to avoid loss of precision. |
|---|
| 192 | Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', $ |
|---|
| 193 | offset=Start_date) ;MMM NN <new line> HH:MM format |
|---|
| 194 | x = findgen(20) * (End_time - Start_time) / 19 + start_time ;Time axis |
|---|
| 195 | PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1 |
|---|
| 196 | |
|---|
| 197 | MODIFICATION HISTORY: |
|---|
| 198 | DMS, RSI. April, 1993. Written. |
|---|
| 199 | DMS, RSI. March, 1997. Added Time format.</div> |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | <h3>Parameters</h3> |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | <h4 id="_LABEL_DATE_param_axis">axis |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | </h4> |
|---|
| 217 | |
|---|
| 218 | <div class="comments"></div> |
|---|
| 219 | |
|---|
| 220 | <h4 id="_LABEL_DATE_param_index">index |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | </h4> |
|---|
| 230 | |
|---|
| 231 | <div class="comments"></div> |
|---|
| 232 | |
|---|
| 233 | <h4 id="_LABEL_DATE_param_x">x |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | </h4> |
|---|
| 243 | |
|---|
| 244 | <div class="comments"></div> |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | <h3>Keywords</h3> |
|---|
| 252 | |
|---|
| 253 | <h4 id="_LABEL_DATE_keyword_DATE_FORMAT">DATE_FORMAT |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | </h4> |
|---|
| 263 | |
|---|
| 264 | <div class="comments"></div> |
|---|
| 265 | |
|---|
| 266 | <h4 id="_LABEL_DATE_keyword_MONTHS">MONTHS |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | </h4> |
|---|
| 276 | |
|---|
| 277 | <div class="comments"></div> |
|---|
| 278 | |
|---|
| 279 | <h4 id="_LABEL_DATE_keyword_OFFSET">OFFSET |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | </h4> |
|---|
| 289 | |
|---|
| 290 | <div class="comments"></div> |
|---|
| 291 | |
|---|
| 292 | <h4 id="_LABEL_DATE_keyword__EXTRA">_EXTRA |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | </h4> |
|---|
| 302 | |
|---|
| 303 | <div class="comments"></div> |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | <h3>Other attributes</h3> |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | <h4>Common blocks used</h4><div class="value">label_date_com</div> |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | </div> |
|---|
| 331 | |
|---|
| 332 | </div> |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 337 | |
|---|
| 338 | </div> |
|---|
| 339 | |
|---|
| 340 | </body> |
|---|
| 341 | </html> |
|---|
