Ignore:
Timestamp:
08/21/06 11:01:50 (18 years ago)
Author:
navarro
Message:

header improvements + xxx doc

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

Legend:

Unmodified
Added
Removed
  • trunk/SRC/ToBeReviewed/STATISTICS/a_correlate2d.pro

    r150 r157  
     1;+ 
     2; 
     3; @file_comments 
     4;  
     5; 
     6; @categories 
     7; Statistics 
     8; 
     9; @param X {in}{required} 
     10; An 2 dimension Array [nx,ny] 
     11; 
     12; @param LAG {in}{required} 
     13; 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], 
     14; of type integer that specifies the absolute distance(s) between  
     15; indexed elements of X. 
     16; 
     17; @keyword ZERO2NAN 
     18; 
     19; @keyword DOUBLE 
     20; If set to a non-zero value, computations are done in double precision arithmetic. 
     21; 
     22; @history 
     23; 28/2/2000 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     24; Based on the A_CORRELATE procedure of IDL 
     25; 
     26; @version 
     27; $Id$ 
     28; 
     29;- 
    130 
    231FUNCTION Auto_Cov2d, X, Lag, Double = Double, zero2nan = zero2nan 
     
    2554; 
    2655; @categories 
    27 ; Statistics. 
     56; Statistics 
    2857; 
    2958; @param X {in}{required} 
     
    4271; 
    4372; @history 
    44 ; 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     73; 28/2/2000 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4574; Based on the A_CORRELATE procedure of IDL 
    4675; 
  • trunk/SRC/ToBeReviewed/STATISTICS/a_timecorrelate.pro

    r150 r157  
     1;+ 
     2; @file_comments 
     3;  
     4; 
     5; @categories 
     6; Statistics 
     7; 
     8; @param X {in}{required} 
     9; An Array which last dimension is the time dimension os 
     10; size n. 
     11; 
     12; @param M 
     13; 
     14; 
     15; @param NT 
     16; 
     17; 
     18; @keyword ZERO2NAN 
     19; 
     20; 
     21; @keyword DOUBLE 
     22; If set to a non-zero value, computations are done in 
     23; double precision arithmetic. 
     24; 
     25; @examples 
     26; 
     27; 
     28; @history 
     29; 
     30; 
     31; @version 
     32; $Id$ 
     33; 
     34;- 
    135FUNCTION TimeAuto_Cov, X, M, nT, Double = Double, zero2nan = zero2nan 
    236;Sample autocovariance function 
     
    4175; 
    4276; @categories 
    43 ; Statistics. 
     77; Statistics 
    4478; 
    4579; @param X {in}{required} 
     
    72106; 
    73107; @history 
    74 ; 24/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     108; 24/2/2000 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    75109; 
    76110; Based on the A_CORRELATE procedure of IDL 
  • trunk/SRC/ToBeReviewed/STATISTICS/c_timecorrelate.pro

    r150 r157  
     1;+ 
     2; @file_comments 
     3;  
     4; 
     5; @categories 
     6; Statistics 
     7; 
     8; @param XD 
     9; 
     10; 
     11; @param YD 
     12; 
     13; 
     14; @param M 
     15; 
     16; 
     17; @param NT 
     18; 
     19; 
     20; @param NDIM 
     21; 
     22; 
     23; @keyword ZERO2NAN 
     24; 
     25; 
     26; @keyword DOUBLE 
     27; If set to a non-zero value, computations are done in 
     28; double precision arithmetic. 
     29; 
     30; @examples 
     31; 
     32; 
     33; @history 
     34; 
     35; 
     36; @version 
     37; $Id$ 
     38; 
     39;- 
    140FUNCTION TimeCross_Cov, Xd, Yd, M, nT, Ndim, Double = Double, ZERO2NAN = zero2nan 
    241  ;Sample cross covariance function. 
     
    3069; 
    3170; @categories 
    32 ; Statistics. 
     71; Statistics 
    3372; 
    3473; @param X {in}{required} 
     
    67106; 
    68107; @history 
    69 ;       - 01/03/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     108;       - 01/03/2000 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    70109;       Based on the C_CORRELATE procedure of IDL 
    71110;       - August 2003 Sebastien Masson  
Note: See TracChangeset for help on using the changeset viewer.