Changeset 238 for trunk/SRC/Grid


Ignore:
Timestamp:
03/27/07 15:43:18 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC/Grid
Files:
14 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Grid/changemsk.pro

    r232 r238  
    1515; 
    1616; @returns 
    17 ; newmsk the new 2D land-sea mask 
     17; the new 2D land-sea mask 
    1818; 
    1919; @examples 
    … …  
    3131;- 
    3232; 
    33 function changemsk,tab, CELLSIZE = cellsize 
     33FUNCTION changemsk,tab, CELLSIZE = cellsize 
    3434; 
    3535  compile_opt idl2, strictarrsubs 
    … …  
    8282   return, newmsk 
    8383end 
    84  

  • trunk/SRC/Grid/checkperio.pro

    r236 r238  
    4545; 
    4646PRO checkperio, file, WRITE = write 
    47  
     47; 
     48  compile_opt idl2, strictarrsubs 
     49; 
    4850  IF file_test(file) EQ 0 THEN BEGIN 
    4951    ras = report( 'file '+file+' not found') 

  • trunk/SRC/Grid/computegrid.pro

    r237 r238  
    128128;       Specify latitudes in this case starty, stepy and ny are not used but 
    129129;       starty and stepy could be necessary if the x axis is not defined with 
    130 ;       xaxis. It must be sorted in the increasing or deceasing order (along each column if 2d array). 
     130;       xaxis. It must be sorted in the increasing or decreasing order (along each column if 2d array). 
    131131; 
    132132; @keyword XYINDEX activate to specify that the horizontal grid should 
    … …  
    209209; 
    210210; @keyword ZAXIS {type=1D} 
    211 ;       Specify the vertical axis. Must be sorted in the increasing or deceasing order 
     211;       Specify the vertical axis. Must be sorted in the increasing or decreasing order 
    212212; 
    213213; @keyword _EXTRA 
    214214; not used in the present case ... 
    215215; 
    216 ; @uses  
    217 ; cm_4mesh cm_4data cm_4cal 
    218 ; 
    219 ; @restrictions  
     216; @uses 
     217; cm_4mesh 
     218; cm_4data 
     219; cm_4cal 
     220; 
     221; @restrictions 
    220222; if the grid has x/y periodicity overlap and/or if 
    221223;    the mask has 0 everywhere at the border (like a closed sea) and 
    … …  
    226228;    to use cell_fill = 1). 
    227229; 
    228 ; @restrictions  
    229230; FUV points definition is not exact if the grid is irregular 
    230231; 

  • trunk/SRC/Grid/micromeshmask.pro

    r237 r238  
    1010; 
    1111; @param inid {in}{required} 
     12; 
    1213; @param outid {in}{required} 
     14; 
    1315; @param inname {in}{required} 
     16; 
    1417; @param outname {in}{optional} 
    1518; 
    … …  
    4346; xxx.mask.nc. In that case, the meshmask is split into 3 files. 
    4447; 
    45 ; @param ncfileout {in}{optional} the name of the uniq reduced meshmask file. 
    46 ; default definition is micromeshmask.nc 
    47 ; 
    48 ; @keyword IODIR to define the files path. 
     48; @param ncfileout {in}{optional} {default='micromeshmask.nc'} 
     49; the name of the uniq reduced meshmask file. 
     50; 
     51; @keyword IODIR 
     52; to define the files path. 
    4953; 
    5054; @examples 

  • trunk/SRC/Grid/n128gaussian.pro

    r231 r238  
    1111; IDL> lat=n128gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n128gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n160gaussian.pro

    r231 r238  
    99; 
    1010; @examples 
    11 ; IDL>lat=n160gaussian() 
     11; IDL> lat=n160gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n160gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n256gaussian.pro

    r231 r238  
    1111; IDL> lat=n256gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n256gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n48gaussian.pro

    r231 r238  
    1111; IDL> lat=n48gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n48gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n80gaussian.pro

    r232 r238  
    11;+ 
    22; 
    3 ; @file_comments  
     3; @file_comments 
    44; compute the latitudes of the n80 gaussian grid. See: 
    55; <a href="http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html">Gaussian 80</a> 
    … …  
    1111; IDL> lat=n80gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n80gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/numbisland.pro

    r231 r238  
    11;+ 
     2; 
    23; @hidden 
    34; 
    … …  
    2425; 
    2526PRO mskneig, msk, nx, ny, indin, numb 
     27; 
     28  compile_opt idl2, strictarrsubs 
     29; 
    2630; flag the point 
    2731  msk[indin] = numb 
    … …  
    3337; build 1d index 
    3438  ind = temporary(indx)#replicate(1L, 3) + replicate(nx, 3)#temporary(indy) 
    35 ; for each neighbourgs on the same island, call again mskneig 
     39; for each neighbourg on the same island, call again mskneig 
    3640  FOR i = 0, n_elements(ind)-1 DO BEGIN 
    3741    IF msk[ind[i]] EQ 0 THEN mskneig, msk, nx, ny, ind[i], numb 
    … …  
    4044  return 
    4145END 
    42  
     46; 
    4347;+ 
     48; 
    4449; @file_comments 
    45 ; given a 2D land-se mask, give a number to each islands 
     50; given a 2D land-sea mask, give a number to each island 
    4651; 
    4752; @categories 
    … …  
    6772; @version 
    6873; $Id$ 
     74; 
    6975;- 
    7076; 
    7177FUNCTION numbisland, mskin 
    72   time1 = systime(1) ; performance measurment 
     78; 
     79  compile_opt idl2, strictarrsubs 
     80; 
     81  time1 = systime(1) ; performance measurement 
    7382  szmsk = size(reform(mskin)) 
    7483  IF szmsk[0] NE 2 THEN stop 

  • trunk/SRC/Grid/restoreboxparam.pro

    r231 r238  
    55; previously defined by <pro>saveboxparam</pro> 
    66; 
    7 ; @param filename {in}{required} 
    8 ; a scalar string defining the file name 
     7; @param filename {in}{required}{type= scalar string} 
     8; the file name 
    99; 
    1010; @uses 

  • trunk/SRC/Grid/romsdepth.pro

    r231 r238  
    1212; 
    1313; @uses 
    14 ; cm_4mesh cm_4data 
     14; cm_4mesh 
     15; cm_4data 
    1516; 
    1617; @restrictions 
    … …  
    2223; @version 
    2324; $Id$ 
     25; 
    2426;- 
    2527; 
    2628FUNCTION romsdepth 
     29; 
     30  compile_opt idl2, strictarrsubs 
    2731; 
    2832@cm_4mesh 

  • trunk/SRC/Grid/saveboxparam.pro

    r231 r238  
    66; (common variable defined by def_myuniquetmpdir) 
    77; 
    8 ; @param filename {in}{required} 
    9 ; a scalar string defining the file name 
     8; @param filename {in}{required} {type=scalar string} 
     9; the file name 
    1010; 
    1111; @uses 

  • trunk/SRC/Grid/smallmeshmask.pro

    r236 r238  
    55; 
    66; @param inid {in}{required} 
     7; 
    78; @param outid {in}{required} 
     9; 
    810; @param inname {in}{required} 
     11; 
    912; @param outname {in}{optional} 
    1013; 
    … …  
    2831; 
    2932;+ 
     33; 
    3034; @file_comments 
    3135; Reduce the size of the NetCDF meshmask created by OPA by 
    … …  
    3337; fields. 
    3438; 
    35 ; @keyword IODIR to define the files path. 
     39; @keyword IODIR 
     40; to define the files path. 
     41; 
    3642; @param ncfilein {in}{required} 
    3743; 1) the name of the meshmask file to be reduced. In that case, 
    … …  
    6066; 
    6167;- 
     68; 
    6269PRO smallmeshmask, ncfilein, ncfileout, IODIR = iodir 
    63 ; 
    6470; 
    6571  compile_opt idl2, strictarrsubs 
Note: See TracChangeset for help on using the changeset viewer.