Changeset 150 for trunk/SRC/ToBeReviewed/STATISTICS/a_correlate2d.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/STATISTICS/a_correlate2d.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/STATISTICS/a_correlate2d.pro

@@ -1 @@
-;+
-; 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).
-;
-; CATEGORY:
-;       Statistics.
-;
-; CALLING SEQUENCE:
-;       Result = a_correlate2d(X, Lag)
-;
-; INPUTS:
-;       X:    an 2 dimension Array [nx,ny]
-;
-;     LAG:    2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)],
-;             of type integer that specifies the absolute distance(s) between 
-;             indexed elements of X.
-;
-; KEYWORD PARAMETERS:
-;       COVARIANCE:    If set to a non-zero value, the sample autocovariance
-;                      is computed.
-;
-;       DOUBLE:        If set to a non-zero value, computations are done in
-;                      double precision arithmetic.
-;
-; EXAMPLE:
-;
-; PROCEDURE:
-;
-;
-;                          nx-k-1  ny-l-1 
-;                          sigma   sigma  (X[i,j]-Xmean)(X[i+k,j+l]-Ymean)
-;                           i=0     j=0
-;   correlation(X,[k,l])=------------------------------------------------------
-;                                  nx-1   ny-1                  
-;                                 sigma  sigma  (X[i,j]-Xmean)^2)
-;                                  i=0    j=0                      
-;
-;
-;                          nx-k-1  ny-l-1 
-;                          sigma   sigma  (X[i,j]-Xmean)(Y[i+k,j+l]-Ymean)
-;                           i=0     j=0
-;   covariance(X,[k,l])=------------------------------------------------------
-;                                            nx*ny
-;
-;   Where Xmean is the mens of the sample population
-;   x=(x[0,0],x[1,0],...,x[nx-1,ny-1]).
-;
-;
-; REFERENCE:
-;
-; MODIFICATION HISTORY:
-;       28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr)
-;       Based on the A_CORRELATE procedure of IDL
-;-
 
 FUNCTION Auto_Cov2d, X, Lag, Double = Double, zero2nan = zero2nan
@@ -77 +17 @@
 
 END
+;+
+;
+; @file_comments
+; 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).
+;
+; @categories
+; Statistics.
+;
+; @param X {in}{required}
+; An 2 dimension Array [nx,ny]
+;
+; @param LAG {in}{required}
+; 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)],
+; of type integer that specifies the absolute distance(s) between 
+; indexed elements of X.
+;
+; @keyword COVARIANCE
+; If set to a non-zero value, the sample autocovariance is computed.
+;
+; @keyword DOUBLE
+; If set to a non-zero value, computations are done in double precision arithmetic.
+;
+; @history
+; 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr)
+; Based on the A_CORRELATE procedure of IDL
+;
+; @version
+; $Id$
+;
+;-
+
 
 FUNCTION A_Correlate2d, X, Lag, Covariance = Covariance, Double = Double