- Timestamp:
- 09/13/06 17:50:54 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html
r168 r177 684 684 <div id="secondary_navbar"> 685 685 686 <a href="n80gaussian.html?format=raw"><<prev file</a> | <a href=" restoreboxparam.html?format=raw">next file >></a> <a href="ncdf_meshread.html?format=raw" 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>686 <a href="n80gaussian.html?format=raw"><<prev file</a> | <a href="ncdf_meshroms.html?format=raw">next file >></a> <a href="ncdf_meshread.html?format=raw" 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> 687 687 688 688 </div> … … 720 720 721 721 <p class="header"> 722 ncdf_meshread<span class="result">[, <a href="#_ncdf_meshread_param_filename">filename</a>]</span>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result"> GLAMBOUNDARY</span>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<span class="result">CHECKDAT</span>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">GETDIMENSIONS</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">string</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>722 ncdf_meshread<span class="result">[, <a href="#_ncdf_meshread_param_filename">filename</a>]</span>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<span class="result">CHECKDAT</span>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 723 723 724 724 <div class="comments"> … … 737 737 738 738 739 740 <span class="attr">default:</span> <span class="value"> meshmask.nc</span>739 <span class="attr">type:</span> <span class="value">scalar string</span> 740 <span class="attr">default:</span> <span class="value">'meshmask.nc'</span> 741 741 742 742 </h4> 743 743 744 <div class="comments"> 745 the name of the meshmask file to read. 746 if this name does not contain any "/" and if 747 iodirectory keyword is not specify, then the common variable 744 <div class="comments"> 745 Name of the meshmask file to read. If this name does not contain any "/" 746 and if iodirectory keyword is not specify, then the common variable 748 747 iodir will be use to define the mesh file path. 749 748 </div> … … 762 761 763 762 764 765 763 <span class="attr">type:</span> <span class="value">2 elements vector</span> 764 <span class="attr">default:</span> <span class="value">those defined in the file</span> 766 765 767 766 </h4> 768 767 769 <div class="comments"> a 2 elements vector, [lon1,lon2], the longitude770 boundaries that should be used to visualize the data.768 <div class="comments"> 769 Longitude boundaries that should be used to visualize the data. 771 770 lon2 > lon1 772 771 lon2 - lon1 le 360 773 key_shift will be automatically defined according to GLAMBOUNDARY. 772 By default, the common (cm_4mesh) variable key_shift will be automatically 773 defined according to GLAMBOUNDARY. 774 774 </div> 775 775 … … 795 795 796 796 797 798 <span class="attr">default:</span> <span class="value"> key_onearth</span>797 <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> 798 <span class="attr">default:</span> <span class="value">1</span> 799 799 800 800 </h4> 801 801 802 802 <div class="comments"> 803 = 0 or 1 to force the manual definition of 804 key_onearth (to specify if the data are on earth -> use longitude 805 /latitude etc...). 806 note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is 807 cancelling GLAMBOUNDARY 803 Force the manual definition of data localization on the earth or not 804 0) if the data are not on the earth 805 1) if the data are on earth (in that case we can for example use 806 the labels 'longitude', 'latitude' in plots). 807 The resulting value will be stored in the common (cm_4mesh) variable key_onearth 808 ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY 808 809 </div> 809 810 … … 814 815 815 816 816 817 817 <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> 818 <span class="attr">default:</span> <span class="value">0</span> 818 819 819 820 </h4> … … 831 832 832 833 833 834 <span class="attr">default:</span> <span class="value"> key_periodic is automaticallycomputed by using the first line of glamt</span>834 <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> 835 <span class="attr">default:</span> <span class="value">computed by using the first line of glamt</span> 835 836 836 837 </h4> 837 838 838 839 <div class="comments"> 839 = 0 or 1 to force the manual definition of 840 key_periodic. 840 Force the manual definition of the grid zonal periodicity. 841 The resulting value will be stored in the common (cm_4mesh) variable key_periodic 842 PERIODIC = 0 forces SHIFT = 0 841 843 </div> 842 844 … … 847 849 848 850 849 850 <span class="attr">default:</span> <span class="value"> key_shift is automatically computed according to theglamboundary</span>851 <span class="attr">type:</span> <span class="value">scalar</span> 852 <span class="attr">default:</span> <span class="value">computed according to glamboundary</span> 851 853 852 854 </h4> 853 855 854 856 <div class="comments"> 855 to force the manual definition of key_shift. By 856 default, key_shift is automatically computed according to the 857 glamboundary (when defined) by using the first line of glamt. if 858 key_periodic=0 then in any case key_shift = 0. 857 Force the manual definition of the zonal shift that must be apply to the data. 858 The resulting value will be stored in the common (cm_4mesh) variable key_shift 859 Note that if key_periodic=0 then in any case key_shift = 0. 859 860 </div> 860 861 … … 865 866 866 867 867 868 <span class="attr">default:</span> <span class="value"> key_stride</span>868 <span class="attr">type:</span> <span class="value">3 elements vector</span> 869 <span class="attr">default:</span> <span class="value">[1, 1, 1]</span> 869 870 870 871 </h4> 871 872 872 <div class="comments"> 873 a 3 elements vector to specify the stride in x, y, z direction. 874 The resulting value will be stored in the common (cm_4mesh) variable 875 key_stride 873 <div class="comments"> 874 Specify the stride in x, y and z direction. The resulting 875 value will be stored in the common (cm_4mesh) variable key_stride 876 876 </div> 877 877 … … 882 882 883 883 884 <span class="attr">type:</span> <span class="value">s tring</span>884 <span class="attr">type:</span> <span class="value">scalar string</span> 885 885 886 886 … … 888 888 889 889 <div class="comments"> 890 a string containing the calling command used to call 891 computegrid (this is used by xxx.pro) 890 the calling command used to call computegrid (this is used by xxx.pro) 892 891 </div> 893 892 … … 903 902 </h4> 904 903 905 <div class="comments"> used to pass your keywords to the created function.904 <div class="comments"> used to pass isafile keywords 906 905 </div> 907 906 … … 913 912 <h3>Version history</h3> 914 913 915 <h4>Version</h4><div class="preformat"> $Id: ncdf_meshread.pro 1 63 2006-08-29 12:59:46Z navarro$914 <h4>Version</h4><div class="preformat"> $Id: ncdf_meshread.pro 172 2006-09-11 07:11:26Z smasson $ 916 915 </div> 917 916 <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) … … 929 928 930 929 931 <h4>Restrictions</h4><div class="preformat"> define and/or use common variables from 932 cm_4mesh, cm_4data, cm_4cal 933 934 930 <h4>Restrictions</h4><div class="preformat"> 935 931 936 932 ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
Note: See TracChangeset
for help on using the changeset viewer.
