- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/INIT/initncdf.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Initfile for Netcdf file. define all the grid parameters 700 </div> 699 701 700 702 … … 711 713 <div class="routine_details" id="_initncdf"> 712 714 713 <h2><a class="top" href="#container">top</a>initncdf </h2> 715 <h2><a class="top" href="#container">top</a>initncdf <span class="categories"> 716 717 </span></h2> 714 718 715 719 <p class="header"> … … 717 721 718 722 <div class="comments"> 719 NAME:initncdf 720 721 PURPOSE:initfile for Netcdf file. define all the grid parameters 722 723 CATEGORY: 724 725 CALLING SEQUENCE:initncdf, ncfilename 726 727 INPUTS:ncfilename: a string giving the name of the NetCdf file 728 729 KEYWORD PARAMETERS: 730 731 GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute 732 boundaries that should be used to visualize the data. 733 lon2 > lon1 734 lon2 - lon1 le 360 735 key_shift will be defined according to GLAMBOUNDARY. 736 737 /INVMASK: to inverse the mask: mask = 1-mask 738 739 IODIRECTORY;a string giving the name of iodirectory (see 740 isafile.pro for all possibilities). default value is common 741 variable iodir 742 743 MASKNAME: a string giving the name of the variable in the file 744 that contains the land/sea mask 745 746 MISSING_VALUE: to define (or redifine if the attribute is 747 already existing) the missing values used with USEASMASK 748 keyword 749 750 /start1: index the axis from 1 instead of 0 when using 751 /xyindex and/or zindex 752 753 USEASMASK: a string giving the name of the variable in the file 754 that will be used to build the land/sea mask. In this case the 755 mask is based on the first record (if record dimension 756 exists). The mask is build according to : 757 1 the keyword missing_value if existing 758 2 the attribute 'missing_value' if existing 759 3 NaN values if existing 760 761 [XYZ]AXISNAME= a string giving the name of the variable in the file 762 that contains the [xyz]axis. 763 for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'. 764 for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'. 765 for Z axis, default name must be 'z', 'level', 'lev', 'depth...' 766 767 [XYZ]MINMESH: to define the common variables i[xyz]minmesh 768 used to define the grid only in a zoomed part of the original 769 grid. Defaut values are 0L 770 771 [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh 772 used to define the grid only in a zoomed part of the original 773 grid. Defaut values are jp[ijk]glo-1 774 775 /xyindex: to define the x/y axis with index instead of using 776 the values contained in X/YAXISNAME. 777 x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 778 this forces key_onearth = 0 779 780 /zindex: to define the z axis with index instead of using 781 the values contained in ZAXISNAME. 782 zaxis = keyword_set(start1) + findgen(jpk) 783 784 OUTPUTS:none, except the grid parameters of the common.pro 785 786 COMMON BLOCKS:common.pro 787 788 SIDE EFFECTS:change the grid parameters of the common.pro 789 790 RESTRICTIONS: 723 </div> 724 725 726 727 728 <h3>Parameters</h3> 729 730 731 <h4 id="_initncdf_param_ncfilein">ncfilein 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 A string giving the name of the NetCdf file 744 </div> 745 746 747 748 749 750 751 <h3>Keywords</h3> 752 753 <h4 id="_initncdf_keyword_XAXISNAME">XAXISNAME 754 755 756 757 758 759 760 761 762 </h4> 763 764 <div class="comments"> 765 A string giving the name of the variable in the file 766 that contains the [xyz]axis. 767 for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'. 768 </div> 769 770 <h4 id="_initncdf_keyword_YAXISNAME">YAXISNAME 771 772 773 774 775 776 777 778 779 </h4> 780 781 <div class="comments"> 782 A string giving the name of the variable in the file 783 that contains the [xyz]axis. 784 for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'. 785 </div> 786 787 <h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME 788 789 790 791 792 793 794 795 796 </h4> 797 798 <div class="comments"> 799 A string giving the name of the variable in the file 800 that contains the [xyz]axis. 801 for Z axis, default name must be 'z', 'level', 'lev', 'depth...' 802 </div> 803 804 <h4 id="_initncdf_keyword_MASKNAME">MASKNAME 805 806 807 808 809 810 811 812 813 </h4> 814 815 <div class="comments"> 816 A string giving the name of the variable in the file 817 that contains the land/sea mask 818 </div> 819 820 <h4 id="_initncdf_keyword_INVMASK">INVMASK 821 822 823 824 825 826 827 828 829 </h4> 830 831 <div class="comments"> 832 To inverse the mask: mask = 1-mask 833 </div> 834 835 <h4 id="_initncdf_keyword_USEASMASK">USEASMASK 836 837 838 839 840 841 842 843 844 </h4> 845 846 <div class="comments"> 847 A string giving the name of the variable in the file 848 that will be used to build the land/sea mask. In this case the 849 mask is based on the first record (if record dimension 850 exists). The mask is build according to : 851 1 the keyword missing_value if existing 852 2 the attribute 'missing_value' if existing 853 3 NaN values if existing 854 </div> 855 856 <h4 id="_initncdf_keyword_MISSING_VALUE">MISSING_VALUE 857 858 859 860 861 862 863 864 865 </h4> 866 867 <div class="comments"> 868 To define (or redifine if the attribute is 869 already existing) the missing values used with USEASMASK 870 keyword 871 </div> 872 873 <h4 id="_initncdf_keyword_START1">START1 874 875 876 877 878 879 880 881 882 </h4> 883 884 <div class="comments"> 885 Index the axis from 1 instead of 0 when using 886 /xyindex and/or zindex 887 </div> 888 889 <h4 id="_initncdf_keyword_XYINDEX">XYINDEX 890 891 892 893 894 895 896 897 898 </h4> 899 900 <div class="comments"> 901 To define the x/y axis with index instead of using 902 the values contained in X/YAXISNAME. 903 x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 904 this forces key_onearth = 0 905 </div> 906 907 <h4 id="_initncdf_keyword_ZINDEX">ZINDEX 908 909 910 911 912 913 914 915 916 </h4> 917 918 <div class="comments"> 919 To define the z axis with index instead of using 920 the values contained in ZAXISNAME. 921 zaxis = keyword_set(start1) + findgen(jpk) 922 </div> 923 924 <h4 id="_initncdf_keyword__EXTRA">_EXTRA 925 926 927 928 929 930 931 932 933 </h4> 934 935 <div class="comments"> 936 Used to pass your keywords/ 937 </div> 938 939 940 941 <h3>Examples</h3><div class="preformat"> 942 IDL> initncdf,'toto.nc',glam=[-180,180] 943 </div> 944 <h3>Version history</h3> 945 946 <h4>Version</h4><div class="preformat"> 947 $Id$ 948 </div> 949 <h4>History</h4><div class="preformat"></div> 950 951 952 <h3>Known issues</h3> 953 954 955 956 <h4>Restrictions</h4><div class="preformat"> 957 Change the grid parameters of the common.pro 958 959 791 960 the file must contain an x and an y axis. (1 ou 2 dimentional array) 792 793 EXAMPLE: IDL> initncdf,'toto.nc',glam=[-180,180] 794 </div> 795 796 797 798 799 <h3>Parameters</h3> 800 801 802 <h4 id="_initncdf_param_ncfilein">ncfilein 803 804 805 806 807 808 809 810 811 </h4> 812 813 <div class="comments"></div> 814 815 816 817 818 819 820 <h3>Keywords</h3> 821 822 <h4 id="_initncdf_keyword_XAXISNAME">XAXISNAME 823 824 825 826 827 828 829 830 831 </h4> 832 833 <div class="comments"></div> 834 835 <h4 id="_initncdf_keyword_YAXISNAME">YAXISNAME 836 837 838 839 840 841 842 843 844 </h4> 845 846 <div class="comments"></div> 847 848 <h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME 849 850 851 852 853 854 855 856 857 </h4> 858 859 <div class="comments"></div> 860 861 <h4 id="_initncdf_keyword_MASKNAME">MASKNAME 862 863 864 865 866 867 868 869 870 </h4> 871 872 <div class="comments"></div> 873 874 <h4 id="_initncdf_keyword_INVMASK">INVMASK 875 876 877 878 879 880 881 882 883 </h4> 884 885 <div class="comments"></div> 886 887 <h4 id="_initncdf_keyword_USEASMASK">USEASMASK 888 889 890 891 892 893 894 895 896 </h4> 897 898 <div class="comments"></div> 899 900 <h4 id="_initncdf_keyword_MISSING_VALUE">MISSING_VALUE 901 902 903 904 905 906 907 908 909 </h4> 910 911 <div class="comments"></div> 912 913 <h4 id="_initncdf_keyword_START1">START1 914 915 916 917 918 919 920 921 922 </h4> 923 924 <div class="comments"></div> 925 926 <h4 id="_initncdf_keyword_XYINDEX">XYINDEX 927 928 929 930 931 932 933 934 935 </h4> 936 937 <div class="comments"></div> 938 939 <h4 id="_initncdf_keyword_ZINDEX">ZINDEX 940 941 942 943 944 945 946 947 948 </h4> 949 950 <div class="comments"></div> 951 952 <h4 id="_initncdf_keyword__EXTRA">_EXTRA 953 954 955 956 957 958 959 960 961 </h4> 962 963 <div class="comments"></div> 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 961 </div> 962 963 <h3>Other attributes</h3> 964 965 966 <h4>Uses routines</h4><div class="preformat"> 967 common.pro 968 </div> 984 969 985 970
Note: See TracChangeset
for help on using the changeset viewer.
