Changeset 268 for trunk/SRC/ToBeReviewed


Ignore:
Timestamp:
08/24/07 16:07:01 (17 years ago)
Author:
pinsard
Message:

typo and links in header in some pro files

Location:
trunk/SRC/ToBeReviewed
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/ToBeReviewed/CALCULS/depth2floatlevel.pro

    r231 r268  
    1010; 
    1111; @param TAB {in}{required} 
    12 ; 2d depth array (or a structure respecting litchamp criterion) 
     12; 2d depth array (or a structure respecting <pro>litchamp</pro> criterion) 
    1313; 
    1414; @keyword NOMASK 
  • trunk/SRC/ToBeReviewed/CALCULS/depth2level.pro

    r232 r268  
    88; 
    99; @param TAB {type=2d array} 
    10 ; 2d depth array (or a structure respecting litchamp criterions) 
     10; 2d depth array (or a structure respecting <pro>litchamp</pro> criterions) 
    1111; 
    1212; @keyword UPPER 
  • trunk/SRC/ToBeReviewed/CALCULS/depth2mask.pro

    r232 r268  
    99; 
    1010; @param TAB {type=3d array} 
    11 ; 2d sill depth array (or a structure respecting litchamp criterions) 
     11; 2d sill depth array (or a structure respecting <pro>litchamp</pro> criterions) 
    1212; 
    1313; @keyword _EXTRA 
  • trunk/SRC/ToBeReviewed/CALCULS/determ2.pro

    r262 r268  
    2929; IDL> a=findgen(2,2,5) 
    3030; IDL> print, determ2(a) 
    31 ; IDL> FOR i=0,4 DO print, determ(a[*,*,i]) ; IDL solution 
     31; IDL> FOR i=0,4 DO print, determ(a[*,*,i]) 
    3232; 
    3333; @history 
  • trunk/SRC/ToBeReviewed/CALCULS/floatlevel2depth.pro

    r262 r268  
    99; 
    1010; @param TAB 
    11 ; 2d array of sill levels (or a structure respecting litchamp criterions) 
     11; 2d array of sill levels (or a structure respecting <pro>litchamp</pro> criterions) 
    1212; 
    1313; @keyword NOMASK 
  • trunk/SRC/ToBeReviewed/CALCULS/grossemoyenne.pro

    r254 r268  
    33; @file_comments 
    44; averages a 3- or 4-d time series field over a selected 
    5 ; geographical area or along the time axis. For one ore more 
     5; geographical area or along the time axis. For one or more 
    66; selected axes (x, y, z, t) 
    77; 
     
    2929; corresponding to nan = !values.f_nan and of 0, which desactivate nan). 
    3030; We have to put NAN=a. 
    31 ; Comment: In output, rsult points which are NAN will be valued a or 
     31; Comment: In output, result points which are NAN will be valued a or 
    3232; !values.f_nan. 
    3333; 
  • trunk/SRC/ToBeReviewed/CALCULS/level2depth.pro

    r231 r268  
    22; 
    33; @file_comments 
    4 ; Allows to pass from a 2d level array to a 2d depth array corresponding o these levels 
     4; Allows to pass from a 2d level array to a 2d depth array corresponding to these levels 
    55; 
    66; @categories 
     
    88; 
    99; @param TAB {in}{required}{type=2d array} 
    10 ; 2d level array of sill levels (or a structure respecting litchamp criterions) 
     10; 2d level array of sill levels (or a structure respecting <pro>litchamp</pro> criterions) 
    1111; 
    1212; @keyword NOMASK 
  • trunk/SRC/ToBeReviewed/CALCULS/moyenne.pro

    r254 r268  
    33; @file_comments 
    44; averages a 2- or 3-d field over a selected 
    5 ;           geographical area and along one ore more 
     5;           geographical area and along one or more 
    66;           selected axes (x, y or z) 
    77; 
  • trunk/SRC/ToBeReviewed/GRILLE/decoupeterre.pro

    r254 r268  
    1212; 
    1313; @categories 
    14 ; Utilities 
     14; Grid 
    1515; 
    1616; @param MASK 
     
    3838; 
    3939; @keyword TRI 
    40 ; This keyword serve to obtain, thanks to grille, the triangulation which 
    41 ; refer to the grid but only on the part of the zoom. This of triangulation 
     40; This keyword serve to obtain, thanks to <pro>grille</pro>, the triangulation which 
     41; refer to the grid but only on the part of the zoom. This array of triangulation 
    4242; is passed in the variable we have equate at TRI. 
    4343; For example: grille,...,tri=triangulation_reduite. 
  • trunk/SRC/ToBeReviewed/GRILLE/domdef.pro

    r254 r268  
    66; 
    77; @categories 
     8; Grid 
    89; 
    910; @param Z1 {in}{optional} 
     
    2728; @keyword ENDPOINTS {type=vector} 
    2829; A four elements vector [x1,y1,x2,y2] used to specify 
    29 ; that <pro>domdef</pro> must define the box used to make a plot (pltz, pltt, 
    30 ; plt1d) done strictly along the line (that can have any direction) 
     30; that <pro>domdef</pro> must define the box used to make a plot 
     31; (<pro>pltz</pro>, <pro>pltt</pro>, <pro>plt1d</pro>) done strictly along the line (that can have any direction) 
    3132; starting at (x1, y1) ending at (x2, y2). When defining endpoints, 
    3233; you must also define TYPE which define the type of plots 
     
    4546; 
    4647; @keyword MEMEINDICES 
    47 ; It is possible that points t,u,v and F correspond to a same geographic 
     48; It is possible that points T, U, V and F correspond to a same geographic 
    4849; box which do not concern the same array indexes. This is sometimes a 
    4950; problem (or at least serious complications) in programs where several 
    50 ; type of grid intervene (see norme, curl...).  
    51 ; Activate MEMEINDICES to force <pro>domdef</pro> to take same indexes - those  
     51; type of grid intervene (see <pro>norme</pro>, <pro>curl</pro>...). 
     52; Activate MEMEINDICES to force <pro>domdef</pro> to take same indexes - those 
    5253; of the grid T- for all other grids. 
    5354; 
    5455; @keyword INDEX 
    55 ; We activate it if we want that all elements passed in input of  
    56 ; <pro>domdef</pro> refer to indexes of glam, gphi and gdep arrays rather  
     56; We activate it if we want that all elements passed in input of 
     57; <pro>domdef</pro> refer to indexes of glam, gphi and gdep arrays rather 
    5758; than to values of these arrays. 
    5859; 
    5960; @keyword XINDEX 
    60 ; We activate it if we want that all elements passed in input of  
    61 ; <pro>domdef</pro>  
     61; We activate it if we want that all elements passed in input of 
     62; <pro>domdef</pro> 
    6263; and concerning the X dimension refer to indexes of glam arrays rather 
    6364; than to values of these arrays. 
    6465; 
    6566; @keyword YINDEX 
    66 ; We activate it if we want that all elements passed in input of  
     67; We activate it if we want that all elements passed in input of 
    6768; <pro>domdef</pro> 
    6869; and concerning the X dimension refer to indexes of gphi arrays rather 
     
    7071; 
    7172; @keyword ZINDEX 
    72 ; We activate it if we want that all elements passed in input of  
     73; We activate it if we want that all elements passed in input of 
    7374; <pro>domdef</pro> 
    7475; and concerning the X dimension refer to indexes of gdep arrays rather 
  • trunk/SRC/ToBeReviewed/GRILLE/f2v.pro

    r231 r268  
    1313; 
    1414; @returns 
    15 ; res, a 2, 3 or 4d array 
     15; a 2d, 3d or 4d array 
    1616; 
    1717; @uses 
  • trunk/SRC/ToBeReviewed/GRILLE/fmask.pro

    r231 r268  
    55; 
    66; @categories 
    7 ; Utilities 
     7; Grid  
    88; 
    99; @returns 
  • trunk/SRC/ToBeReviewed/GRILLE/grille.pro

    r232 r268  
    1111; 
    1212; @categories 
     13; Grid 
    1314; 
    1415; @keyword TRI 
    15 ; This keyword serve to obtain, thanks to grille, the triangulation which 
    16 ; refer to the grid but only on the part of the zoom. This of triangulation 
     16; This keyword serve to obtain the triangulation which 
     17; refer to the grid but only on the part of the zoom. This array of triangulation 
    1718; is passed in the variable we have equate at TRI. 
    1819; For example: grille,...,tri=triangulation_reduite. 
     
    2930; 
    3031; @keyword NOTRI 
    31 ; Useful only when TRI is activated. In this case, grill send back -1 in the 
     32; Useful only when TRI is activated. In this case, grille send back -1 in the 
    3233; variable tri even if the variable of the common triangles_list is defined 
    3334; and different of -1 
  • trunk/SRC/ToBeReviewed/GRILLE/t2v.pro

    r231 r268  
    99; 
    1010; @param TEMP {in}{required} 
    11 ; A 2, 3 or 4d array 
     11; A 2d, 3d or 4d array 
    1212; 
    1313; @returns 
    14 ; res, a 2, 3 or 4d array 
     14; a 2d, 3d or 4d array 
    1515; 
    1616; @uses 
  • trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro

    r254 r268  
    55; 
    66; @categories 
     7; Grid 
    78; 
    89; @param GLAMIN {in}{optional}{type=1d or 2d array}{default=glam specified by vargrid, on the domain defined by <pro>domdef</pro>} 
  • trunk/SRC/ToBeReviewed/GRILLE/u2t.pro

    r231 r268  
    1010; 
    1111; @param TEMP {in}{required} 
    12 ; A 2, 3 or 4d array 
     12; A 2d, 3d or 4d array 
    1313; 
    1414; @returns 
    15 ; res, a 2, 3 or 4d array 
     15; a 2d, 3d or 4d array 
    1616; 
    1717; @uses 
  • trunk/SRC/ToBeReviewed/GRILLE/umask.pro

    r231 r268  
    55; 
    66; @categories 
    7 ; Utilities 
     7; Grid  
    88; 
    99; @returns 
     
    1515; @examples 
    1616; Used like if umask was a known array by substituing umask by (umask()) 
    17 ; For example: Instaed of write umask[domainef] we have to write (umask())[domainef] 
     17; For example: Instead of write umask[domainef] we have to write (umask())[domainef] 
    1818; 
    1919; @history 
  • trunk/SRC/ToBeReviewed/GRILLE/v2t.pro

    r231 r268  
    1010; 
    1111; @param TEMP {in}{required} 
    12 ; A 2, 3 or 4d array 
     12; A 2d, 3d or 4d array 
    1313; 
    1414; @returns 
    15 ; res, a 2, 3 or 4d array 
     15; a 2d, 3d or 4d array 
    1616; 
    1717; @uses 
  • trunk/SRC/ToBeReviewed/GRILLE/vmask.pro

    r231 r268  
    55; 
    66; @categories 
    7 ; Utilities 
     7; Grid  
    88; 
    99; @returns 
     
    1212; @examples 
    1313; Used like if vmask was a known array by substituing vmask by (vmask()) 
    14 ; For example: Instaed of write vmask[domainef] we have to write (vmask())[domainef] 
     14; For example: Instead of write vmask[domainef] we have to write (vmask())[domainef] 
    1515; 
    1616; @history 
Note: See TracChangeset for help on using the changeset viewer.