Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/velovect.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/VECTEUR/velovect.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Produce a two-dimensional velocity field plot. 700 701 A directed arrow is drawn at each point showing the direction and 702 magnitude of the field. 703 </div> 699 704 700 705 … … 711 716 <div class="routine_details" id="_VELOVECT"> 712 717 713 <h2><a class="top" href="#container">top</a>VELOVECT </h2> 718 <h2><a class="top" href="#container">top</a>VELOVECT <span class="categories"> 719 Plotting, two-dimensional. 720 721 </span></h2> 714 722 715 723 <p class="header"> 716 VELOVECT<span class="result">, <a href="#_VELOVECT_param_U">U</a>, <a href="#_VELOVECT_param_V">V</a> , <a href="#_VELOVECT_param_X">X</a>, <a href="#_VELOVECT_param_Y">Y</a></span>, <a href="#_VELOVECT_keyword_Missing">Missing</a>=<span class="result">Missing</span>, <a href="#_VELOVECT_keyword_Length">Length</a>=<span class="result">Length</span>, <a href="#_VELOVECT_keyword_Dots">Dots</a>=<span class="result">Dots</span>, <a href="#_VELOVECT_keyword_Color">Color</a>=<span class="result">Color</span>, <a href="#_VELOVECT_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_VELOVECT_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_VELOVECT_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_VELOVECT_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>724 VELOVECT<span class="result">, <a href="#_VELOVECT_param_U">U</a>, <a href="#_VELOVECT_param_V">V</a>[, <a href="#_VELOVECT_param_X">X</a>][, <a href="#_VELOVECT_param_Y">Y</a>]</span>, <a href="#_VELOVECT_keyword_Missing">Missing</a>=<span class="result">Missing</span>, <a href="#_VELOVECT_keyword_Length">Length</a>=<span class="result">Length</span>, <a href="#_VELOVECT_keyword_Dots">Dots</a>=<span class="result">Dots</span>, <a href="#_VELOVECT_keyword_Color">Color</a>=<span class="result">Color</span>, <a href="#_VELOVECT_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_VELOVECT_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_VELOVECT_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_VELOVECT_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 717 725 718 726 <div class="comments"> 719 NAME: 720 VELOVECT 721 722 PURPOSE: 723 Produce a two-dimensional velocity field plot. 724 725 A directed arrow is drawn at each point showing the direction and 726 magnitude of the field. 727 728 CATEGORY: 729 Plotting, two-dimensional. 730 731 CALLING SEQUENCE: 732 VELOVECT, U, V [, X, Y] 733 734 INPUTS: 735 U: The X component of the two-dimensional field. 736 U must be a two-dimensional array. 737 738 V: The Y component of the two dimensional field. Y must have 739 the same dimensions as X. The vector at point [i,j] has a 740 magnitude of: 741 742 (U[i,j]^2 + V[i,j]^2)^0.5 743 744 and a direction of: 745 746 ATAN2(V[i,j],U[i,j]). 747 748 OPTIONAL INPUT PARAMETERS: 749 X: Optional abcissae values. X must be a vector with a length 750 equal to the first dimension of U and V. 751 752 Y: Optional ordinate values. Y must be a vector with a length 753 equal to the first dimension of U and V. 754 755 KEYWORD INPUT PARAMETERS: 756 COLOR: The color index used for the plot. 757 758 DOTS: Set this keyword to 1 to place a dot at each missing point. 759 Set this keyword to 0 or omit it to draw nothing for missing 760 points. Has effect only if MISSING is specified. 761 762 LENGTH: Length factor. The default of 1.0 makes the longest (U,V) 763 vector the length of a cell. 764 765 MISSING: Missing data value. Vectors with a LENGTH greater 766 than MISSING are ignored. 767 768 OVERPLOT: Set this keyword to make VELOVECT "overplot". That is, the 769 current graphics screen is not erased, no axes are drawn, and 770 the previously established scaling remains in effect. 771 772 773 Note: All other keywords are passed directly to the PLOT procedure 774 and may be used to set option such as TITLE, POSITION, 775 NOERASE, etc. 776 OUTPUTS: 777 None. 778 779 COMMON BLOCKS: 780 None. 781 782 SIDE EFFECTS: 783 Plotting on the selected device is performed. System 784 variables concerning plotting are changed. 785 786 RESTRICTIONS: 787 None. 788 789 PROCEDURE: 790 Straightforward. Unrecognized keywords are passed to the PLOT 791 procedure. 792 793 MODIFICATION HISTORY: 727 </div> 728 729 730 731 732 <h3>Parameters</h3> 733 734 735 <h4 id="_VELOVECT_param_U">U 736 <span class="attr">in</span> 737 738 739 <span class="attr">required</span> 740 741 742 743 744 </h4> 745 746 <div class="comments"> 747 The X component of the two-dimensional field. 748 U must be a two-dimensional array. 749 </div> 750 751 <h4 id="_VELOVECT_param_V">V 752 <span class="attr">in</span> 753 754 755 <span class="attr">required</span> 756 757 758 759 760 </h4> 761 762 <div class="comments"> 763 The Y component of the two dimensional field. Y must have 764 the same dimensions as X. The vector at point [i,j] has a 765 magnitude of: 766 767 (U[i,j]^2 + V[i,j]^2)^0.5 768 769 and a direction of: 770 771 ATAN2(V[i,j],U[i,j]). 772 </div> 773 774 <h4 id="_VELOVECT_param_X">X 775 <span class="attr">in</span> 776 777 <span class="attr">optional</span> 778 779 780 781 782 783 </h4> 784 785 <div class="comments"> 786 Optional abcissae values. X must be a vector with a length 787 equal to the first dimension of U and V. 788 </div> 789 790 <h4 id="_VELOVECT_param_Y">Y 791 <span class="attr">in</span> 792 793 <span class="attr">optional</span> 794 795 796 797 798 799 </h4> 800 801 <div class="comments"> 802 Optional ordinate values. Y must be a vector with a length 803 equal to the first dimension of U and V. 804 </div> 805 806 807 808 809 810 811 <h3>Keywords</h3> 812 813 <h4 id="_VELOVECT_keyword_Missing">Missing 814 815 816 817 818 819 820 821 822 </h4> 823 824 <div class="comments"> 825 Missing data value. Vectors with a LENGTH greater 826 than MISSING are ignored. 827 </div> 828 829 <h4 id="_VELOVECT_keyword_Length">Length 830 831 832 833 834 835 836 837 838 </h4> 839 840 <div class="comments"> 841 Length factor. The default of 1.0 makes the longest (U,V) 842 vector the length of a cell. 843 </div> 844 845 <h4 id="_VELOVECT_keyword_Dots">Dots 846 847 848 849 850 851 852 853 854 </h4> 855 856 <div class="comments"> 857 Set this keyword to 1 to place a dot at each missing point. 858 Set this keyword to 0 or omit it to draw nothing for missing 859 points. Has effect only if MISSING is specified. 860 </div> 861 862 <h4 id="_VELOVECT_keyword_Color">Color 863 864 865 866 867 868 869 870 871 </h4> 872 873 <div class="comments"> 874 The color index used for the plot. 875 </div> 876 877 <h4 id="_VELOVECT_keyword_CLIP">CLIP 878 879 880 881 882 883 884 885 886 </h4> 887 888 <div class="comments"> 889 </div> 890 891 <h4 id="_VELOVECT_keyword_NOCLIP">NOCLIP 892 893 894 895 896 897 898 899 900 </h4> 901 902 <div class="comments"> 903 </div> 904 905 <h4 id="_VELOVECT_keyword_OVERPLOT">OVERPLOT 906 907 908 909 910 911 912 913 914 </h4> 915 916 <div class="comments"> 917 Set this keyword to make VELOVECT "overplot". That is, the 918 current graphics screen is not erased, no axes are drawn, and 919 the previously established scaling remains in effect. 920 </div> 921 922 <h4 id="_VELOVECT_keyword__EXTRA">_EXTRA 923 924 925 926 927 928 929 930 931 </h4> 932 933 <div class="comments"> 934 Used to pass your keywords. 935 </div> 936 937 938 939 940 <h3>Version history</h3> 941 942 <h4>Version</h4><div class="preformat"> 943 $Id: velovect.pro 134 2006-07-07 10:19:08Z navarro $ 944 </div> 945 <h4>History</h4><div class="preformat"> 794 946 DMS, RSI, Oct., 1983. 795 947 For Sun, DMS, RSI, April, 1989. … … 806 958 September, 1996, GGS. Changed denominator of x_step and y_step vars. 807 959 February, 1998, DLD. Add support for CLIP and NO_CLIP keywords. 808 June, 1998, DLD. Add support for OVERPLOT keyword.</div> 809 810 811 812 813 <h3>Parameters</h3> 814 815 816 <h4 id="_VELOVECT_param_U">U 817 818 819 820 821 822 823 824 825 </h4> 826 827 <div class="comments"></div> 828 829 <h4 id="_VELOVECT_param_V">V 830 831 832 833 834 835 836 837 838 </h4> 839 840 <div class="comments"></div> 841 842 <h4 id="_VELOVECT_param_X">X 843 844 845 846 847 848 849 850 851 </h4> 852 853 <div class="comments"></div> 854 855 <h4 id="_VELOVECT_param_Y">Y 856 857 858 859 860 861 862 863 864 </h4> 865 866 <div class="comments"></div> 867 868 869 870 871 872 873 <h3>Keywords</h3> 874 875 <h4 id="_VELOVECT_keyword_Missing">Missing 876 877 878 879 880 881 882 883 884 </h4> 885 886 <div class="comments"></div> 887 888 <h4 id="_VELOVECT_keyword_Length">Length 889 890 891 892 893 894 895 896 897 </h4> 898 899 <div class="comments"></div> 900 901 <h4 id="_VELOVECT_keyword_Dots">Dots 902 903 904 905 906 907 908 909 910 </h4> 911 912 <div class="comments"></div> 913 914 <h4 id="_VELOVECT_keyword_Color">Color 915 916 917 918 919 920 921 922 923 </h4> 924 925 <div class="comments"></div> 926 927 <h4 id="_VELOVECT_keyword_CLIP">CLIP 928 929 930 931 932 933 934 935 936 </h4> 937 938 <div class="comments"></div> 939 940 <h4 id="_VELOVECT_keyword_NOCLIP">NOCLIP 941 942 943 944 945 946 947 948 949 </h4> 950 951 <div class="comments"></div> 952 953 <h4 id="_VELOVECT_keyword_OVERPLOT">OVERPLOT 954 955 956 957 958 959 960 961 962 </h4> 963 964 <div class="comments"></div> 965 966 <h4 id="_VELOVECT_keyword__EXTRA">_EXTRA 967 968 969 970 971 972 973 974 975 </h4> 976 977 <div class="comments"></div> 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 960 June, 1998, DLD. Add support for OVERPLOT keyword. 961 962 Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved. 963 Unauthorized reproduction prohibited. 964 </div> 965 966 967 <h3>Known issues</h3> 968 969 970 971 <h4>Restrictions</h4><div class="preformat"> 972 Plotting on the selected device is performed. System 973 variables concerning plotting are changed. 974 Note: All other keywords are passed directly to the PLOT procedure 975 and may be used to set option such as TITLE, POSITION, 976 NOERASE, etc. 977 </div> 993 978 994 979
Note: See TracChangeset
for help on using the changeset viewer.
