Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/LABEL/label_date.html
- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/LABEL/label_date.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 This function labels axes with dates and times. 700 </div> 699 701 700 702 … … 711 713 <div class="routine_details" id="_LABEL_DATE"> 712 714 713 <h2><a class="top" href="#container">top</a>LABEL_DATE </h2> 715 <h2><a class="top" href="#container">top</a>LABEL_DATE <span class="categories"> 716 Plotting. 717 </span></h2> 714 718 715 719 <p class="header"> … … 717 721 718 722 <div class="comments"> 719 NAME: 720 LABEL_DATE 721 722 PURPOSE: 723 This function labels axes with dates and times. 724 725 CATEGORY: 726 Plotting. 727 728 CALLING SEQUENCE: 729 To set up: 730 dummy = LABEL_DATE(DATE_FORMAT='string') 731 To use: 732 PLOT, x, y, XTICKFORMAT='LABEL_DATE' 733 734 INPUTS: 735 No explicit user defined inputs. When called from the plotting 736 routines, the input parameters are (Axis, Index, Value) 737 738 KEYWORD PARAMETERS: 739 DATE_FORMAT: a format string which may contain the following: 740 %M for month (3 character abbr) 741 %N for month (2 digit abbr) 742 %D for day of month, 743 %Y for 4 digit year. 744 %Z for last two digits of year. 745 For time: 746 %H for Hours, 2 digits. 747 %I for mInutes, 2 digits. 748 %S for Seconds, 2 digits. 749 %% is %. 750 Other characters are passed directly thru. 751 For example, '%M %D, %Y' prints DEC 11, 1993 752 '%M %2Y' yields DEC 93 753 '%D-%M' yields 11-DEC 754 '%D/%N/%Y' yields 11/12/1993 755 '%M!C%Y' yields DEC on the top line, 1993 on 756 the bottom (!C is the new line graphic command). 757 758 MONTHS: The names of the months, a twelve element string array. 759 If omitted, use Jan, Feb, ..., Dec. 760 761 OFFSET: An optional starting offset of the plot. 762 Unfortunately, single precision floating point is not accurate 763 enough to properly represent Julian times. This offset, which 764 may be double precision, contains an offset that is added to 765 all x values, before conversion to Julian date and time. 766 767 OUTPUTS: 768 The date string to be plotted. 769 770 COMMON BLOCKS: 771 LABEL_DATE_COM. 772 773 RESTRICTIONS: 774 Only one date axis may be simultaneously active. 775 776 PROCEDURE: 777 Straightforward. 778 779 For an alternative way to label a plot axis with dates, refer to 780 the C() format code accepted within format strings (applicable via 781 the [XYZ]TICKFORMAT keywords). This new format code was 782 introduced in IDL 5.2. 783 784 EXAMPLE: 785 For example, to plot from Jan 1, 1993, to July 12, 1994: 786 Start_date = julday(1, 1, 1993) 787 End_date = julday(7, 12, 1994) 788 Dummy = LABEL_DATE(DATE_FORMAT='%N/%D') ;Simple mm/dd 789 x = findgen(end_date+1 - start_date) + start_date ;Time axis 790 PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1 791 (Plot with X axis style set to exact.) 723 </div> 724 725 726 727 728 <h3>Parameters</h3> 729 730 731 <h4 id="_LABEL_DATE_param_axis">axis 732 <span class="attr">in</span> 733 734 735 <span class="attr">required</span> 736 737 738 739 740 </h4> 741 742 <div class="comments"> 743 </div> 744 745 <h4 id="_LABEL_DATE_param_index">index 746 <span class="attr">in</span> 747 748 749 <span class="attr">required</span> 750 751 752 753 754 </h4> 755 756 <div class="comments"> 757 </div> 758 759 <h4 id="_LABEL_DATE_param_x">x 760 <span class="attr">in</span> 761 762 763 <span class="attr">required</span> 764 765 766 767 768 </h4> 769 770 <div class="comments"> 771 </div> 772 773 774 775 776 777 778 <h3>Keywords</h3> 779 780 <h4 id="_LABEL_DATE_keyword_DATE_FORMAT">DATE_FORMAT 781 782 783 784 785 786 787 788 789 </h4> 790 791 <div class="comments"> 792 a format string which may contain the following: 793 %M for month (3 character abbr) 794 %N for month (2 digit abbr) 795 %D for day of month, 796 %Y for 4 digit year. 797 %Z for last two digits of year. 798 For time: 799 %H for Hours, 2 digits. 800 %I for mInutes, 2 digits. 801 %S for Seconds, 2 digits. 802 %% is %. 803 Other characters are passed directly thru. 804 For example, '%M %D, %Y' prints DEC 11, 1993 805 '%M %2Y' yields DEC 93 806 '%D-%M' yields 11-DEC 807 '%D/%N/%Y' yields 11/12/1993 808 '%M!C%Y' yields DEC on the top line, 1993 on 809 the bottom (!C is the new line graphic command). 810 </div> 811 812 <h4 id="_LABEL_DATE_keyword_MONTHS">MONTHS 813 814 815 816 817 818 819 820 821 </h4> 822 823 <div class="comments"> 824 The names of the months, a twelve element string array. 825 If omitted, use Jan, Feb, ..., Dec. 826 </div> 827 828 <h4 id="_LABEL_DATE_keyword_OFFSET">OFFSET 829 830 831 832 833 834 835 836 837 </h4> 838 839 <div class="comments"> 840 An optional starting offset of the plot. 841 Unfortunately, single precision floating point is not accurate 842 enough to properly represent Julian times. This offset, which 843 may be double precision, contains an offset that is added to 844 all x values, before conversion to Julian date and time. 845 </div> 846 847 <h4 id="_LABEL_DATE_keyword__EXTRA">_EXTRA 848 849 850 851 852 853 854 855 856 </h4> 857 858 <div class="comments"></div> 859 860 861 862 <h3>Examples</h3><div class="preformat"> 863 For example, to plot from Jan 1, 1993, to July 12, 1994: 864 Start_date = julday(1, 1, 1993) 865 End_date = julday(7, 12, 1994) 866 Dummy = LABEL_DATE(DATE_FORMAT='%N/%D') ;Simple mm/dd 867 x = findgen(end_date+1 - start_date) + start_date ;Time axis 868 PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1 869 (Plot with X axis style set to exact.) 792 870 793 871 Example with times: … … 803 881 x = findgen(20) * (End_time - Start_time) / 19 + start_time ;Time axis 804 882 PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1 805 806 MODIFICATION HISTORY: 883 </div> 884 <h3>Version history</h3> 885 886 <h4>Version</h4><div class="preformat"> 887 $Id: label_date.pro 134 2006-07-07 10:19:08Z navarro $ 888 </div> 889 <h4>History</h4><div class="preformat"> 807 890 DMS, RSI. April, 1993. Written. 808 DMS, RSI. March, 1997. Added Time format.</div> 809 810 811 812 813 <h3>Parameters</h3> 814 815 816 <h4 id="_LABEL_DATE_param_axis">axis 817 818 819 820 821 822 823 824 825 </h4> 826 827 <div class="comments"></div> 828 829 <h4 id="_LABEL_DATE_param_index">index 830 831 832 833 834 835 836 837 838 </h4> 839 840 <div class="comments"></div> 841 842 <h4 id="_LABEL_DATE_param_x">x 843 844 845 846 847 848 849 850 851 </h4> 852 853 <div class="comments"></div> 854 855 856 857 858 859 860 <h3>Keywords</h3> 861 862 <h4 id="_LABEL_DATE_keyword_DATE_FORMAT">DATE_FORMAT 863 864 865 866 867 868 869 870 871 </h4> 872 873 <div class="comments"></div> 874 875 <h4 id="_LABEL_DATE_keyword_MONTHS">MONTHS 876 877 878 879 880 881 882 883 884 </h4> 885 886 <div class="comments"></div> 887 888 <h4 id="_LABEL_DATE_keyword_OFFSET">OFFSET 889 890 891 892 893 894 895 896 897 </h4> 898 899 <div class="comments"></div> 900 901 <h4 id="_LABEL_DATE_keyword__EXTRA">_EXTRA 902 903 904 905 906 907 908 909 910 </h4> 911 912 <div class="comments"></div> 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 891 DMS, RSI. March, 1997. Added Time format. 892 893 Copyright (c) 1993-1998, Research Systems, Inc. All rights reserved. 894 Unauthorized reproduction prohibited. 895 </div> 896 897 898 <h3>Known issues</h3> 899 900 901 902 <h4>Restrictions</h4><div class="preformat"> 903 Only one date axis may be simultaneously active. 904 </div> 928 905 929 906 <h3>Other attributes</h3> 930 907 931 908 932 909 <h4>Uses routines</h4><div class="preformat"> 910 LABEL_DATE_COM. 911 </div> 933 912 934 913
Note: See TracChangeset
for help on using the changeset viewer.
