Changeset 155 for trunk/SRC/Grid


Ignore:
Timestamp:
08/11/06 16:32:05 (18 years ago)
Author:
smasson
Message:

some light header cleaning...

Location:
trunk/SRC/Grid
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Grid/changemsk.pro

    r152 r155  
    33;------------------------------------------------------------ 
    44; 
    5 ; @file_comments add land points on a 2D land-sea mask 
     5; @file_comments add land points on a 2D land-sea mask wit mouse clicking 
    66; 
    77; @categories grid 
    … …  
    1313; 
    1414; @keyword NOUSEINFOS activite to supress the printed message explaining 
    15 ;                     how to use tvplus 
     15;                     how to use changemsk 
    1616; 
    1717; @returns newmsk the new 2D land-sea mask 
    … …  
    3131;------------------------------------------------------------ 
    3232;------------------------------------------------------------ 
    33 function changemsk,tab, CELLSIZE = cellsize 
     33function changemsk, tab, CELLSIZE = cellsize, NOUSEINFOS = nouseinfos  
    3434; 
    3535  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/micromeshmask.pro

    r134 r155  
     1;------------------------------------------------------ 
    12;+ 
    23; 
    3 ; @file_comments reduce the size of the NetCDF meshmask created by OPA by 
    4 ; using bit (and not byte) format for the masks and the float format 
    5 ; for the other fields. 
    6 ; 
    7 ; @categories for OPA meshmask files 
    8 ; 
     4; @hidden 
     5; @categories netcdf 
    96; @param inid {in}{required} 
    107; @param outid {in}{required} 
    118; @param inname {in}{required} 
    12 ; @param outname {in}{optional} 
    13 ; 
    14 ; @history 
    15 ;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    16 ; 
    17 ; @version $Id$ 
     9; @param outname {in}{optional}{default=inname} 
    1810; 
    1911;- 
    20 ;------------------------------------------------------ 
    2112;------------------------------------------------------ 
    2213PRO ncdf_transfer, inid, outid, inname, outname 
    … …  
    2920  RETURN 
    3021END 
     22;------------------------------------------------------ 
    3123; 
    3224;+ 
     25; @file_comments reduce the size of the NetCDF meshmask created by OPA by 
     26; using bit (and not byte) format for the masks and the float format 
     27; for the other variables 
     28; 
     29; @categories for OPA meshmask files 
    3330; 
    3431; @param ncfilein {in}{required} 
    … …  
    5047; IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    5148; 
     49; @history 
     50;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     51; 
     52; @version $Id$ 
     53; 
    5254;- 
     55;------------------------------------------------------ 
    5356PRO micromeshmask, ncfilein, ncfileout, IODIR = iodir 
    5457; 

  • trunk/SRC/Grid/ncdf_meshread.pro

    r134 r155  
    3333; 
    3434; @keyword GETDIMENSIONS 
     35;    Activate this keywords if you only want to know the dimension 
     36;    of the domain stored in the mesh file. This dimensions will be 
     37;    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables) 
    3538; 
    3639; @keyword PERIODIC = 0 or 1 to force the manual definition of 

  • trunk/SRC/Grid/restoreboxparam.pro

    r134 r155  
    55; 
    66; @file_comments restore all the zoom parameters (defined by calling domdef) 
    7 ;          perviously defined by saveboxparam 
     7; perviously defined by saveboxparam 
     8; 
     9; @param filename {in}{required}  
     10; a scalar string defining the file name  
     11; 
     12; @uses cm_4mesh (and cm_demomode_used if we are in demo mode) 
     13; 
     14; @restrictions call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
     15;               => define, create and add it to !path 
    816; 
    917; @examples 
    1018; IDL> restoreboxparam, filename 
    1119;  
    12 ; @param filename {in}{required} a scalar string defining the file name  
    13 ; 
    14 ; @uses cm_4mesh and cm_demomode_used if we are in demo mode 
    15 ; 
    16 ; @restrictions all def_myuniquetmpdir, if myuniquetmpdir is undefined:  
    17 ;               => define, create and add it to !path 
    18 ; 
    1920; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2021;                      July 2005 

  • trunk/SRC/Grid/saveboxparam.pro

    r134 r155  
    55; 
    66; @file_comments save all the zoom parameters (defined by calling domdef) 
    7 ;          in a file (using save command) located in myuniquetmpdir 
    8 ;          (common variable defined by def_myuniquetmpdir) 
     7; in a file (using save command) located in myuniquetmpdir 
     8; (common variable defined by def_myuniquetmpdir) 
     9;  
     10; @param filename {in}{required} a scalar string defining the file name  
     11; 
     12; @uses cm_4mesh (and cm_demomode_used if we are in demo mode) 
     13; 
     14; @restrictions call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
     15;               => define, create and add it to !path 
    916; 
    1017; @examples 
    1118; IDL> saveboxparam, filename 
    12 ;  
    13 ; @param filename {in}{required} a scalar string defining the file name  
    14 ; 
    15 ; @uses cm_4mesh and cm_demomode_used if we are in demo mode 
    16 ; 
    17 ; @restrictions call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
    18 ;               => define, create and add it to !path 
    1919; 
    2020; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 

  • trunk/SRC/Grid/smallmeshmask.pro

    r134 r155  
     1;------------------------------------------------------ 
    12;+ 
    23; 
    3 ; 
    4 ; @categories for OPA meshmask files 
    5 ; 
     4; @hidden 
     5; @categories netcdf 
    66; @param inid {in}{required} 
    77; @param outid {in}{required} 
    88; @param inname {in}{required} 
    9 ; @param outname {in}{optional} 
    10 ; 
    11 ; @history 
    12 ;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    13 ; 
    14 ; @version $Id$ 
     9; @param outname {in}{optional}{default=inname} 
    1510; 
    1611;- 
    17 ;------------------------------------------------------ 
    1812;------------------------------------------------------ 
    1913PRO ncdf_transfer, inid, outid, inname, outname 
    … …  
    2620  RETURN 
    2721END 
     22;------------------------------------------------------ 
    2823; 
    2924;+ 
    3025; @file_comments reduce the size of the NetCDF meshmask created by OPA by 
    3126; using byte format for the masks and the float format for the other 
    32 ; fields. 
    33 ; 
    34 ; @keyword IODIR to define the files path. 
     27; variables. 
     28; 
     29; @categories for OPA meshmask files 
     30; 
    3531; @param ncfilein {in}{required} 
    3632; 1) the name of the meshmask file to be reduced. In that case, 
    … …  
    4541; the name of the reduced meshmask file.  
    4642; 
     43; @keyword IODIR to define the files path. 
     44; 
    4745; @examples 
    4846; IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    4947; IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    5048; 
    51 ; @categories for OPA meshmask files 
    52 ; 
    5349; @history 
    5450;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    … …  
    5753; 
    5854;- 
     55;------------------------------------------------------ 
    5956PRO smallmeshmask, ncfilein, ncfileout, IODIR = iodir 
    6057; 
Note: See TracChangeset for help on using the changeset viewer.