Changeset 163 for trunk/SRC/ToBeReviewed/STATISTICS/c_timecorrelate.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/ToBeReviewed/STATISTICS/c_timecorrelate.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/STATISTICS/c_timecorrelate.pro

@@ -38 +38 @@
 ;
 ;-
-FUNCTION TimeCross_Cov, Xd, Yd, M, nT, Ndim, Double = Double, ZERO2NAN = zero2nan
+FUNCTION timecross_cov, Xd, Yd, M, nT, Ndim, Double = Double, ZERO2NAN = zero2nan
   ;Sample cross covariance function.
 
@@ -71 +71 @@
 ; Statistics
 ;
-; @param X {in}{required}
+; @param X {in}{required}{type=array}
 ; An Array which last dimension is the time dimension of
 ; size n, float or double.
 ;
-; @param Y {in}{required}
+; @param Y {in}{required}{type=array}
 ; An Array which last dimension is the time dimension of
 ; size n, float or double.
 ;
-; @param LAG {in}{required}
+; @param LAG {in}{required}{type=scalar or vector}
 ; A scalar or n-element vector, in the interval [-(n-2), (n-2)],
 ; of type integer that specifies the absolute distance(s) between
@@ -120 +120 @@
 ;
 ;-
-FUNCTION C_Timecorrelate, X, Y, Lag, Covariance = Covariance, Double = Double
+FUNCTION c_timecorrelate, X, Y, Lag, Covariance = Covariance, Double = Double
 
 ;Compute the sample cross correlation or cross covariance of