- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/HOPE/read_hope.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Read the Hope grid file converted in NetCdf by xconv 700 </div> 699 701 700 702 … … 711 713 712 714 <dt><p><a href="#_read_hope_event">read_hope_event<span class="result">, event</span></a></p><dt> 713 <dd> NAME: read_hope PURPOSE: read the Hope grid file converted in NetCdf by xconv CATEGORY: reading CALLING SEQUENCE: a=read_hope([typein, varnamein]) INPUTS: typein: a string specifing from which type of section the 4D array based: 'xy, 'xz', 'yz' varnamein: a string the name of the cariable to be read (in lower or upper case) KEYWORD PARAMETERS: FILENAME = the name of the file to be read XLIMITS = a two elements vertor [lonmin, lonmax]] the bondary of the longitudes (from 0 to 360) YLIMITS = a two elements vertor [latmin, latmax]] the bondary of the latitudes (from -90 to 90) ZLIMITS = a two elements vertor [depthmin, depthmax]] the bondary of the depth TLIMITS = a two elements vertor [date1, date2]] the bondary of the calendar with date1 and date2 folowing the syntaxe yyyymmdd /ODDPT: activate to read only the sections located on ODD points /EVENPT: activate to read only the sections located on even points /ODDEVENPT: activate to read only the sections located on both even and odd points (horizontal sections) OUTPUTS: -1 if typein and varnamein are undefine (this is the widget version) a structure which but be read by litchamp.</dd>715 <dd></dd> 714 716 715 717 <dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">FILENAME</span>, XLIMITS=<span class="result">XLIMITS</span>, YLIMITS=<span class="result">YLIMITS</span>, ZLIMITS=<span class="result">ZLIMITS</span>, TLIMITS=<span class="result">TLIMITS</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _extra=<span class="result">_extra</span>)</a></p><dt> 716 <dd> </dd>718 <dd> </dd> 717 719 718 720 </dl> … … 730 732 read_hope_event<span class="result">, <a href="#_read_hope_event_param_event">event</a></span></p> 731 733 734 <div class="comments"></div> 735 736 737 738 739 <h3>Parameters</h3> 740 741 742 <h4 id="_read_hope_event_param_event">event 743 744 745 746 747 748 749 750 751 </h4> 752 753 <div class="comments"></div> 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 </div> 784 785 786 <div class="routine_details" id="_read_hope"> 787 788 <h2><a class="top" href="#container">top</a>read_hope <span class="categories"> 789 Reading 790 </span></h2> 791 792 <p class="header"> 793 <span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">XLIMITS</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">YLIMITS</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">ZLIMITS</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">TLIMITS</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 794 732 795 <div class="comments"> 733 NAME: read_hope 734 735 PURPOSE: read the Hope grid file converted in NetCdf by xconv 736 737 CATEGORY: reading 738 739 CALLING SEQUENCE: a=read_hope([typein, varnamein]) 740 741 INPUTS: 742 typein: a string specifing from which type of section the 4D 743 array based: 'xy, 'xz', 'yz' 744 745 varnamein: a string the name of the cariable to be read (in 746 lower or upper case) 747 748 KEYWORD PARAMETERS: 749 750 FILENAME = the name of the file to be read 751 752 XLIMITS = a two elements vertor [lonmin, lonmax]] 753 the bondary of the longitudes (from 0 to 360) 754 755 YLIMITS = a two elements vertor [latmin, latmax]] 756 the bondary of the latitudes (from -90 to 90) 757 758 ZLIMITS = a two elements vertor [depthmin, depthmax]] 759 the bondary of the depth 760 761 TLIMITS = a two elements vertor [date1, date2]] 762 the bondary of the calendar with date1 and date2 763 folowing the syntaxe yyyymmdd 764 765 /ODDPT: activate to read only the sections located on ODD 766 points 767 768 /EVENPT: activate to read only the sections located on even 769 points 770 771 /ODDEVENPT: activate to read only the sections located on 772 both even and odd points (horizontal sections) 773 774 OUTPUTS: 775 776 -1 if typein and varnamein are undefine (this is the widget 777 version) 778 779 a structure which but be read by litchamp.pro and is 780 necessary to complute the grid associated to the data (see 781 the example). 782 783 COMMON BLOCKS: common.pro (usefull only for the definition of iodir) 784 785 SIDE EFFECTS: 786 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv 787 must be able to works with this kind of fonction. 788 The grib file has no zoom possibilities on horizontal 789 dimensions. 790 791 RESTRICTIONS: 792 793 When typein and varnamein are defined, the methode to find the 794 godd variable is: 795 1) find the variables which are available on this type of 796 sections woth this name 797 2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only 798 these types of sections 799 3) for an XY section the chosen variable is the one which has 800 the most level in the vertical domain specified by ZLIMITS. 801 for an XZ section the chosen variable is the one which has 802 the most points in the latitude domain specified by YLIMITS. 803 for an YZ section the chosen variable is the one which has 804 the most points in the longitude domain specified by XLIMITS. 805 806 807 EXAMPLE: 796 </div> 797 798 <h3>Return value</h3><div class="preformat"> 799 -1 if typein and varnamein are undefine (this is the widget 800 version) 801 802 A structure which but be read by litchamp.pro and is 803 necessary to complute the grid associated to the data (see 804 the example). 805 </div> 806 807 808 <h3>Parameters</h3> 809 810 811 <h4 id="_read_hope_param_typein">typein 812 <span class="attr">in</span> 813 814 815 <span class="attr">required</span> 816 817 818 819 820 </h4> 821 822 <div class="comments"> 823 A string specifing from which type of section the 4D 824 array based: 'xy, 'xz', 'yz' 825 </div> 826 827 <h4 id="_read_hope_param_varnamein">varnamein 828 829 830 831 832 833 834 835 836 </h4> 837 838 <div class="comments"> 839 A string the name of the cariable to be read (in 840 lower or upper case) 841 </div> 842 843 844 845 846 847 848 <h3>Keywords</h3> 849 850 <h4 id="_read_hope_keyword_FILENAME">FILENAME 851 852 853 854 855 856 857 858 859 </h4> 860 861 <div class="comments"> 862 The name of the file to be read 863 </div> 864 865 <h4 id="_read_hope_keyword_XLIMITS">XLIMITS 866 867 868 869 870 871 872 873 874 </h4> 875 876 <div class="comments"> 877 A two elements vertor [lonmin, lonmax]] 878 the bondary of the longitudes (from 0 to 360) 879 </div> 880 881 <h4 id="_read_hope_keyword_YLIMITS">YLIMITS 882 883 884 885 886 887 888 889 890 </h4> 891 892 <div class="comments"> 893 A two elements vertor [latmin, latmax]] 894 the bondary of the latitudes (from -90 to 90) 895 </div> 896 897 <h4 id="_read_hope_keyword_ZLIMITS">ZLIMITS 898 899 900 901 902 903 904 905 906 </h4> 907 908 <div class="comments"> 909 A two elements vertor [depthmin, depthmax]] 910 the bondary of the depth 911 </div> 912 913 <h4 id="_read_hope_keyword_TLIMITS">TLIMITS 914 915 916 917 918 919 920 921 922 </h4> 923 924 <div class="comments"> 925 A two elements vertor [date1, date2]] 926 the bondary of the calendar with date1 and date2 927 folowing the syntaxe yyyymmdd 928 </div> 929 930 <h4 id="_read_hope_keyword_ODDPT">ODDPT 931 932 933 934 935 936 937 938 939 </h4> 940 941 <div class="comments"> 942 Activate to read only the sections located on ODD 943 points 944 </div> 945 946 <h4 id="_read_hope_keyword_ODDEVENPT">ODDEVENPT 947 948 949 950 951 952 953 954 955 </h4> 956 957 <div class="comments"> 958 Activate to read only the sections located on 959 both even and odd points (horizontal sections) 960 </div> 961 962 <h4 id="_read_hope_keyword_EVENPT">EVENPT 963 964 965 966 967 968 969 970 971 </h4> 972 973 <div class="comments"> 974 Activate to read only the sections located on even 975 points 976 </div> 977 978 <h4 id="_read_hope_keyword__extra">_extra 979 980 981 982 983 984 985 986 987 </h4> 988 989 <div class="comments"> 990 Used to pass yor keywords 991 </div> 992 993 994 995 <h3>Examples</h3><div class="preformat"> 808 996 809 997 IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc') … … 829 1017 <Expression> FLOAT = Array[128, 242, 15] 830 1018 </div> 831 832 833 834 835 <h3>Parameters</h3> 836 837 838 <h4 id="_read_hope_event_param_event">event 839 840 841 842 843 844 845 846 847 </h4> 848 849 <div class="comments"></div> 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 </div> 880 881 882 <div class="routine_details" id="_read_hope"> 883 884 <h2><a class="top" href="#container">top</a>read_hope </h2> 885 886 <p class="header"> 887 <span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">XLIMITS</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">YLIMITS</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">ZLIMITS</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">TLIMITS</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 888 889 <div class="comments"></div> 890 891 892 893 894 <h3>Parameters</h3> 895 896 897 <h4 id="_read_hope_param_typein">typein 898 899 900 901 902 903 904 905 906 </h4> 907 908 <div class="comments"></div> 909 910 <h4 id="_read_hope_param_varnamein">varnamein 911 912 913 914 915 916 917 918 919 </h4> 920 921 <div class="comments"></div> 922 923 924 925 926 927 928 <h3>Keywords</h3> 929 930 <h4 id="_read_hope_keyword_FILENAME">FILENAME 931 932 933 934 935 936 937 938 939 </h4> 940 941 <div class="comments"></div> 942 943 <h4 id="_read_hope_keyword_XLIMITS">XLIMITS 944 945 946 947 948 949 950 951 952 </h4> 953 954 <div class="comments"></div> 955 956 <h4 id="_read_hope_keyword_YLIMITS">YLIMITS 957 958 959 960 961 962 963 964 965 </h4> 966 967 <div class="comments"></div> 968 969 <h4 id="_read_hope_keyword_ZLIMITS">ZLIMITS 970 971 972 973 974 975 976 977 978 </h4> 979 980 <div class="comments"></div> 981 982 <h4 id="_read_hope_keyword_TLIMITS">TLIMITS 983 984 985 986 987 988 989 990 991 </h4> 992 993 <div class="comments"></div> 994 995 <h4 id="_read_hope_keyword_ODDPT">ODDPT 996 997 998 999 1000 1001 1002 1003 1004 </h4> 1005 1006 <div class="comments"></div> 1007 1008 <h4 id="_read_hope_keyword_ODDEVENPT">ODDEVENPT 1009 1010 1011 1012 1013 1014 1015 1016 1017 </h4> 1018 1019 <div class="comments"></div> 1020 1021 <h4 id="_read_hope_keyword_EVENPT">EVENPT 1022 1023 1024 1025 1026 1027 1028 1029 1030 </h4> 1031 1032 <div class="comments"></div> 1033 1034 <h4 id="_read_hope_keyword__extra">_extra 1035 1036 1037 1038 1039 1040 1041 1042 1043 </h4> 1044 1045 <div class="comments"></div> 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1019 <h3>Version history</h3> 1020 1021 <h4>Version</h4><div class="preformat"> 1022 $Id$ 1023 </div> 1024 <h4>History</h4><div class="preformat"></div> 1025 1026 1027 <h3>Known issues</h3> 1028 1029 1030 1031 <h4>Restrictions</h4><div class="preformat"> 1032 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv 1033 must be able to works with this kind of fonction. 1034 The grib file has no zoom possibilities on horizontal dimensions. 1035 1036 1037 1038 When typein and varnamein are defined, the methode to find the 1039 godd variable is: 1040 1) find the variables which are available on this type of 1041 sections woth this name 1042 2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only 1043 these types of sections 1044 3) For an XY section the chosen variable is the one which has 1045 the most level in the vertical domain specified by ZLIMITS. 1046 For an XZ section the chosen variable is the one which has 1047 the most points in the latitude domain specified by YLIMITS. 1048 For an YZ section the chosen variable is the one which has 1049 the most points in the longitude domain specified by XLIMITS. 1050 1051 </div> 1052 1053 <h3>Other attributes</h3> 1054 1055 1056 <h4>Uses routines</h4><div class="preformat"> 1057 common.pro (usefull only for the definition of iodir) 1058 </div> 1066 1059 1067 1060
Note: See TracChangeset
for help on using the changeset viewer.
