Changeset 151 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_correlate2d.html
- Timestamp:
- 08/09/06 12:21:11 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_correlate2d.html
r138 r151 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 This function computes the autocorrelation Px(K,L) or 700 autocovariance Rx(K,L) of a sample population X[nx,ny] as a 701 function of the lag (K,L). 702 </div> 699 703 700 704 … … 711 715 712 716 <dt><p><a href="#_Auto_Cov2d"><span class="result">result = </span>Auto_Cov2d(<span class="result">X, Lag</span>, Double=<span class="result">Double</span>, zero2nan=<span class="result">zero2nan</span>)</a></p><dt> 713 <dd> NAME: A_CORRELATE2d PURPOSE: This function computes the autocorrelation Px(K,L) or autocovariance Rx(K,L) of a sample population X[nx,ny] as a function of the lag (K,L).</dd>717 <dd></dd> 714 718 715 719 <dt><p><a href="#_A_Correlate2d"><span class="result">result = </span>A_Correlate2d(<span class="result">X, Lag</span>, Covariance=<span class="result">Covariance</span>, Double=<span class="result">Double</span>)</a></p><dt> 716 <dd> </dd>720 <dd> </dd> 717 721 718 722 </dl> … … 730 734 <span class="result">result = </span>Auto_Cov2d(<span class="result"><a href="#_Auto_Cov2d_param_X">X</a>, <a href="#_Auto_Cov2d_param_Lag">Lag</a></span>, <a href="#_Auto_Cov2d_keyword_Double">Double</a>=<span class="result">Double</span>, <a href="#_Auto_Cov2d_keyword_zero2nan">zero2nan</a>=<span class="result">zero2nan</span>)</p> 731 735 732 <div class="comments"> 733 NAME: 734 A_CORRELATE2d 735 736 PURPOSE: 737 738 This function computes the autocorrelation Px(K,L) or 739 autocovariance Rx(K,L) of a sample population X[nx,ny] as a 740 function of the lag (K,L). 741 742 CATEGORY: 743 Statistics. 744 745 CALLING SEQUENCE: 746 Result = a_correlate2d(X, Lag) 747 748 INPUTS: 749 X: an 2 dimension Array [nx,ny] 750 751 LAG: 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], 752 of type integer that specifies the absolute distance(s) between 753 indexed elements of X. 754 755 KEYWORD PARAMETERS: 756 COVARIANCE: If set to a non-zero value, the sample autocovariance 757 is computed. 758 759 DOUBLE: If set to a non-zero value, computations are done in 760 double precision arithmetic. 761 762 EXAMPLE: 763 764 PROCEDURE: 765 766 767 nx-k-1 ny-l-1 768 sigma sigma (X[i,j]-Xmean)(X[i+k,j+l]-Ymean) 769 i=0 j=0 770 correlation(X,[k,l])=------------------------------------------------------ 771 nx-1 ny-1 772 sigma sigma (X[i,j]-Xmean)^2) 773 i=0 j=0 774 775 776 nx-k-1 ny-l-1 777 sigma sigma (X[i,j]-Xmean)(Y[i+k,j+l]-Ymean) 778 i=0 j=0 779 covariance(X,[k,l])=------------------------------------------------------ 780 nx*ny 781 782 Where Xmean is the mens of the sample population 783 x=(x[0,0],x[1,0],...,x[nx-1,ny-1]). 784 785 786 REFERENCE: 787 788 MODIFICATION HISTORY:</div> 736 <div class="comments"></div> 789 737 790 738 … … 883 831 <div class="routine_details" id="_A_Correlate2d"> 884 832 885 <h2><a class="top" href="#container">top</a>A_Correlate2d </h2> 833 <h2><a class="top" href="#container">top</a>A_Correlate2d <span class="categories"> 834 Statistics. 835 </span></h2> 886 836 887 837 <p class="header"> 888 838 <span class="result">result = </span>A_Correlate2d(<span class="result"><a href="#_A_Correlate2d_param_X">X</a>, <a href="#_A_Correlate2d_param_Lag">Lag</a></span>, <a href="#_A_Correlate2d_keyword_Covariance">Covariance</a>=<span class="result">Covariance</span>, <a href="#_A_Correlate2d_keyword_Double">Double</a>=<span class="result">Double</span>)</p> 889 839 890 <div class="comments"></div> 840 <div class="comments"> 841 </div> 891 842 892 843 … … 897 848 898 849 <h4 id="_A_Correlate2d_param_X">X 899 900 901 902 850 <span class="attr">in</span> 851 852 853 <span class="attr">required</span> 903 854 904 855 … … 907 858 </h4> 908 859 909 <div class="comments"></div> 860 <div class="comments"> 861 An 2 dimension Array [nx,ny] 862 </div> 910 863 911 864 <h4 id="_A_Correlate2d_param_Lag">Lag 912 913 914 915 865 <span class="attr">in</span> 866 867 868 <span class="attr">required</span> 916 869 917 870 … … 920 873 </h4> 921 874 922 <div class="comments"></div> 875 <div class="comments"> 876 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], 877 of type integer that specifies the absolute distance(s) between 878 indexed elements of X. 879 </div> 923 880 924 881 … … 940 897 </h4> 941 898 942 <div class="comments"></div> 899 <div class="comments"> 900 If set to a non-zero value, the sample autocovariance is computed. 901 </div> 943 902 944 903 <h4 id="_A_Correlate2d_keyword_Double">Double … … 953 912 </h4> 954 913 955 <div class="comments"></div> 956 957 958 959 960 961 962 963 914 <div class="comments"> 915 If set to a non-zero value, computations are done in double precision arithmetic. 916 </div> 917 918 919 920 921 <h3>Version history</h3> 922 923 <h4>Version</h4><div class="preformat"> 924 $Id: a_correlate2d.pro 150 2006-08-09 10:12:54Z navarro $ 925 </div> 926 <h4>History</h4><div class="preformat"></div> 964 927 965 928
Note: See TracChangeset
for help on using the changeset viewer.
