- Timestamp:
- 08/09/06 12:21:11 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html
r142 r151 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Reading function for the file net_cdf. 700 This program is less universal than ncdf_lec (it appeal to declarated 701 variables in common.pro) but it is very easier to be used. It considerate 702 the declaration of the different zooms which have been defined 703 (ixminmesh...premierx...), the declaration of the variable key_shift... 704 To put it in a nutshell, the result of read_ncdf can be directly used in plt... 705 This is also this program which is used by default inour reading widgets. 706 </div> 699 707 700 708 … … 711 719 <div class="routine_details" id="_read_ncdf"> 712 720 713 <h2><a class="top" href="#container">top</a>read_ncdf </h2> 721 <h2><a class="top" href="#container">top</a>read_ncdf <span class="categories"> 722 reading 723 724 </span></h2> 714 725 715 726 <p class="header"> 716 <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_debut">debut</a>, <a href="#_read_ncdf_param_fin">fin</a>, <a href="#_read_ncdf_param_pour_etre_compatible">pour_etre_compatible</a></span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">TIMEVAR</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">INIT</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 727 <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>, <a href="#_read_ncdf_param_compatibility">compatibility</a></span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">TIMEVAR</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">INIT</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 728 729 <div class="comments"></div> 730 731 <h3>Return value</h3><div class="preformat"> 732 Structure readable by litchamp.pro or an array if NOSRUCT is activated. 733 </div> 734 735 736 <h3>Parameters</h3> 737 738 739 <h4 id="_read_ncdf_param_name">name 740 <span class="attr">in</span> 741 742 743 <span class="attr">required</span> 744 745 746 747 748 </h4> 717 749 718 750 <div class="comments"> 719 720 PURPOSE:fonction de lecture pour fichier net_cdf. 721 Ce programme, est moins universel que ncdf_lec (il fait appelle au 722 variables declarees dans common.pro) mais il est du cop bcp plus 723 facile d''utilisation. Il prend en compte la declaration des 724 differents zoom qui ont ete definis (ixminmesh...premierx...) la 725 declaration de la variable key_shift... bref le resultat de 726 read_ncdf peut dorectement etre utilise dans plt... 727 C''est aussi ce programme qui est utilise par defaut dans mes 728 widgets pour la partie lecture. 729 730 CATEGORY:lecture de fichiers NetCdf 731 732 CALLING SEQUENCE:res = read_ncdf(name,debut[,fin]) 733 734 INPUTS: name: un string definissant le champ a lire. 735 debut et fin: sont relatifs a l''axe des temps. Ce peut etre 736 - 2 dates du type yyyymmdd et ds ce cas on selectionne les 737 dates qui sont comprisent entre ces 2 dates. 738 - 2 indices qui definissent entre quel et quel pas de temps 739 on doit extraire la dimension temporelle. 740 exp: ne sert a rien! 741 742 KEYWORD PARAMETERS: utilisables hors du contexte des widgets 743 744 BOXZOOM: contient la boxzoom sur laquelle on doit faire la 745 lecture 746 FILENAME: string contennant le nom du fichier 747 /INIT; to call automatically initncdf, filename and thus 748 redefine all the grid parameters 749 GRID='[UTVWF]' to specify the type of grid. Defaut is (1) 750 based on the name of the file if the file ends by 751 GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1) 752 is not found. 753 IODIRECTORY;a string giving the name of iodirectory (see 754 isafile.pro for all possibilities). default value is common 755 variable iodir 756 TIMESTEP:activer pour specifier que debut et fin font 757 reference a des indices de l''axe du temps et non pas a des 758 dates. 759 TOUT: activer si on veut lire le ficher sur l''ensemble du 760 domaine sans tenir compte du sous domaine definit par boxzoom 761 ou lon1,lon2,lat1,lat2,vert1,vert2. 762 NOSTRUCT: activer si on ne veut pas que read_ncdf reourne 763 une structure mais uniquement le tableau se rapportant au 764 champ. 765 TIMEVAR: a string to define the name of the variable that 766 contains the time axis. This keyword can be usefull if there 767 is no unlimited dimension or if the time axis selected by defaut 768 (the first 1D array with unlimited dimension) is not the good one 769 770 771 OUTPUTS:une stucture lisible par litchamp.pro ou un simple tableau 772 si /NOSTRUCT est active 773 774 COMMON BLOCKS:common.pro 775 776 SIDE EFFECTS: 777 778 RESTRICTIONS:le champ doit avoir une dimension temporelle 779 780 EXAMPLE: 751 It is a string defining the field to be read. 781 752 </div> 782 783 784 785 786 <h3>Parameters</h3> 787 788 789 <h4 id="_read_ncdf_param_name">name 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"></div> 801 802 <h4 id="_read_ncdf_param_debut">debut 803 804 805 806 807 808 809 810 811 </h4> 812 813 <div class="comments"></div> 814 815 <h4 id="_read_ncdf_param_fin">fin 816 817 818 819 820 821 822 823 824 </h4> 825 826 <div class="comments"></div> 827 828 <h4 id="_read_ncdf_param_pour_etre_compatible">pour_etre_compatible 829 830 831 832 833 834 835 836 837 </h4> 838 839 <div class="comments"></div> 753 754 <h4 id="_read_ncdf_param_beginning">beginning 755 <span class="attr">in</span> 756 757 758 <span class="attr">required</span> 759 760 761 762 763 </h4> 764 765 <div class="comments"> 766 Relative with the time axis. 767 These can be 768 - 2 date of the type yyyymmdd and in this case, we select dates 769 which are included between these two dates. 770 - 2 indexes which define between which and which time step we have 771 to extract the telporal dimension. 772 </div> 773 774 <h4 id="_read_ncdf_param_ending">ending 775 <span class="attr">in</span> 776 777 778 <span class="attr">required</span> 779 780 781 782 783 </h4> 784 785 <div class="comments"> 786 Relative with the time axis. 787 See BEGINNING. 788 </div> 789 790 <h4 id="_read_ncdf_param_compatibility">compatibility 791 <span class="attr">in</span> 792 793 794 <span class="attr">required</span> 795 796 797 798 799 </h4> 800 801 <div class="comments"> 802 Useless 803 </div> 840 804 841 805 … … 857 821 </h4> 858 822 823 <div class="comments"> 824 Contain the boxzoom on which we have to do the reading 825 </div> 826 827 <h4 id="_read_ncdf_keyword_FILENAME">FILENAME 828 829 830 831 832 833 834 835 836 </h4> 837 838 <div class="comments"> 839 It is a string containing the file's name. 840 </div> 841 842 <h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN 843 844 845 846 847 848 849 850 851 </h4> 852 859 853 <div class="comments"></div> 860 854 861 <h4 id="_read_ncdf_keyword_FILENAME">FILENAME 855 <h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP 856 857 858 859 860 861 862 863 864 </h4> 865 866 <div class="comments"> 867 We activate to specify that BEGINNING and ENDING refer to indexes 868 of the time axis and not to dates 869 </div> 870 871 <h4 id="_read_ncdf_keyword_TIMEVAR">TIMEVAR 872 873 874 875 876 877 878 879 880 </h4> 881 882 <div class="comments"> 883 It is a string which define the name of the variable that 884 contains the time axis. This keyword can be usefull if there 885 is no unlimited dimension or if the time axis selected by defaut 886 (the first 1D array with unlimited dimension) is not the good one. 887 </div> 888 889 <h4 id="_read_ncdf_keyword_TOUT">TOUT 890 891 892 893 894 895 896 897 898 </h4> 899 900 <div class="comments"> 901 We activate it if we want to read the file on the whole domain without 902 considerate the sub-domain defined by the boxzoom or 903 lon1,lon2,lat1,lat2,vert1,vert2. 904 </div> 905 906 <h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT 907 908 909 910 911 912 913 914 915 </h4> 916 917 <div class="comments"> 918 We activate it if we do not want that read_ncdf send back a structure 919 but only the array refering to the field. 920 </div> 921 922 <h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL 862 923 863 924 … … 872 933 <div class="comments"></div> 873 934 874 <h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN 935 <h4 id="_read_ncdf_keyword_INIT">INIT 936 937 938 939 940 941 942 943 944 </h4> 945 946 <div class="comments"> 947 To call automatically initncdf, filename and thus 948 redefine all the grid parameters 949 </div> 950 951 <h4 id="_read_ncdf_keyword_GRID">GRID 952 953 954 955 956 957 958 959 960 </h4> 961 962 <div class="comments"> 963 ='[UTVWF]' to specify the type of grid. Defaut is (1) 964 based on the name of the file if the file ends by 965 GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1) 966 is not found. 967 </div> 968 969 <h4 id="_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE 875 970 876 971 … … 885 980 <div class="comments"></div> 886 981 887 <h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP 888 889 890 891 892 893 894 895 896 </h4>897 898 <div class="comments"></div>899 900 <h4 id="_read_ncdf_keyword_TIMEVAR">TIMEVAR 901 902 903 904 905 906 907 908 909 </h4>910 911 <div class="comments"></div>912 913 <h4 id="_read_ncdf_keyword_TOUT">TOUT 914 915 916 917 918 919 920 921 922 </h4>923 924 <div class="comments"></div>925 926 <h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT 927 928 929 930 931 932 933 934 935 </h4>936 937 <div class="comments"></div>938 939 <h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL 940 941 942 943 944 945 946 947 948 </h4>949 950 <div class="comments"></div>951 952 <h4 id="_read_ncdf_keyword_INIT">INIT 953 954 955 956 957 958 959 960 961 </h4>962 963 <div class="comments"></div>964 965 <h4 id="_read_ncdf_keyword_GRID">GRID 966 967 968 969 970 971 972 973 974 </h4>975 976 <div class="comments"></div>977 978 <h4 id="_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE 979 980 981 982 983 984 985 986 987 </h4>988 989 <div class="comments"></div>990 991 982 <h4 id="_read_ncdf_keyword__EXTRA">_EXTRA 992 983 … … 1000 991 </h4> 1001 992 1002 <div class="comments"></div> 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 993 <div class="comments"> 994 Used to pass your keywords 995 </div> 996 997 998 999 1000 <h3>Version history</h3> 1001 1002 <h4>Version</h4><div class="preformat"> 1003 $Id: read_ncdf.pro 150 2006-08-09 10:12:54Z navarro $ </div> 1004 <h4>History</h4><div class="preformat"></div> 1005 1006 1007 <h3>Known issues</h3> 1008 1009 1010 1011 <h4>Restrictions</h4><div class="preformat"> 1012 The field must have a temporal dimension. 1013 </div> 1014 1015 <h3>Other attributes</h3> 1016 1017 1018 <h4>Uses routines</h4><div class="preformat"> 1019 common.pro 1020 </div> 1023 1021 1024 1022
Note: See TracChangeset
for help on using the changeset viewer.
