Ignore:
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)

Location:
trunk/SRC/ToBeReviewed/STATISTICS
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/STATISTICS/a_correlate2d.pro

    r157 r163  
    2929;- 
    3030 
    31 FUNCTION Auto_Cov2d, X, Lag, Double = Double, zero2nan = zero2nan 
     31FUNCTION auto_cov2d, X, Lag, Double = Double, zero2nan = zero2nan 
    3232; 
    3333  compile_opt idl2, strictarrsubs 
    … …  
    8080 
    8181 
    82 FUNCTION A_Correlate2d, X, Lag, Covariance = Covariance, Double = Double 
     82FUNCTION a_correlate2d, X, Lag, Covariance = Covariance, Double = Double 
    8383; 
    8484  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/STATISTICS/a_timecorrelate.pro

    r157 r163  
    66; Statistics 
    77; 
    8 ; @param X {in}{required} 
    9 ; An Array which last dimension is the time dimension os 
     8; @param X {in}{required}{type=array} 
     9; An Array which last dimension is the time dimension so 
    1010; size n. 
    1111; 
    … …  
    3333; 
    3434;- 
    35 FUNCTION TimeAuto_Cov, X, M, nT, Double = Double, zero2nan = zero2nan 
     35FUNCTION timeauto_cov, X, M, nT, Double = Double, zero2nan = zero2nan 
    3636;Sample autocovariance function 
    3737; 
    … …  
    7777; Statistics 
    7878; 
    79 ; @param X {in}{required} 
    80 ; An Array which last dimension is the time dimension os 
     79; @param X {in}{required}{type=array} 
     80; An Array which last dimension is the time dimension so 
    8181; size n. 
    8282; 
    83 ; @param LAG {in}{required} 
     83; @param LAG {in}{required}{type=scalar or vector} 
    8484; A scalar or n-element vector, in the interval [-(n-2), (n-2)], 
    8585; of type integer that specifies the absolute distance(s) between  
    … …  
    118118;- 
    119119 
    120 FUNCTION A_TimeCorrelate, X, Lag, COVARIANCE = Covariance, DOUBLE = Double 
     120FUNCTION a_timecorrelate, X, Lag, COVARIANCE = Covariance, DOUBLE = Double 
    121121; 
    122122  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/STATISTICS/c_timecorrelate.pro

    r157 r163  
    3838; 
    3939;- 
    40 FUNCTION TimeCross_Cov, Xd, Yd, M, nT, Ndim, Double = Double, ZERO2NAN = zero2nan 
     40FUNCTION timecross_cov, Xd, Yd, M, nT, Ndim, Double = Double, ZERO2NAN = zero2nan 
    4141  ;Sample cross covariance function. 
    4242 
    … …  
    7171; Statistics 
    7272; 
    73 ; @param X {in}{required} 
     73; @param X {in}{required}{type=array} 
    7474; An Array which last dimension is the time dimension of 
    7575; size n, float or double. 
    7676; 
    77 ; @param Y {in}{required} 
     77; @param Y {in}{required}{type=array} 
    7878; An Array which last dimension is the time dimension of 
    7979; size n, float or double. 
    8080; 
    81 ; @param LAG {in}{required} 
     81; @param LAG {in}{required}{type=scalar or vector} 
    8282; A scalar or n-element vector, in the interval [-(n-2), (n-2)], 
    8383; of type integer that specifies the absolute distance(s) between 
    … …  
    120120; 
    121121;- 
    122 FUNCTION C_Timecorrelate, X, Y, Lag, Covariance = Covariance, Double = Double 
     122FUNCTION c_timecorrelate, X, Y, Lag, Covariance = Covariance, Double = Double 
    123123 
    124124;Compute the sample cross correlation or cross covariance of  
Note: See TracChangeset for help on using the changeset viewer.