Changeset 142 for trunk/SRC/ToBeReviewed/INIT/initncdf.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/INIT/initncdf.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/INIT/initncdf.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:initncdf
-;
-; PURPOSE:initfile for Netcdf file. define all the grid parameters
-;
-; CATEGORY:
-;
-; CALLING SEQUENCE:initncdf, ncfilename
+;
+; @file_comments
+; Initfile for Netcdf file. define all the grid parameters
+;
+; @categories
+;
 ; 
-; INPUTS:ncfilename: a string giving the name of the NetCdf file
-;
-; KEYWORD PARAMETERS:
-;
-;       GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute
-;       boundaries that should be used to visualize the data.
-;         lon2 > lon1
-;         lon2 - lon1 le 360
-;       key_shift will be defined according to GLAMBOUNDARY.
-;
-;       /INVMASK: to inverse the mask: mask = 1-mask
-;
-;       IODIRECTORY;a string giving the name of iodirectory (see
-;       isafile.pro for all possibilities). default value is common 
-;       variable iodir
-;
-;       MASKNAME: a string giving the name of the variable in the file 
-;       that contains the land/sea mask
-;
-;       MISSING_VALUE: to define (or redifine if the attribute is
-;       already existing) the missing values used with USEASMASK
-;       keyword
-;
-;       /start1: index the axis from 1 instead of 0 when using
-;       /xyindex and/or zindex
-;
-;       USEASMASK: a string giving the name of the variable in the file 
-;       that will be used to build the land/sea mask. In this case the
-;       mask is based on the first record (if record dimension
-;       exists). The mask is build according to :
-;         1 the keyword missing_value if existing
-;         2 the attribute 'missing_value' if existing
-;         3 NaN values if existing
-;
-;       [XYZ]AXISNAME= a string giving the name of the variable in the file 
-;       that contains the [xyz]axis. 
-;       for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'.
-;       for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'.
-;       for Z axis, default name must be 'z', 'level', 'lev', 'depth...'
-;
-;       [XYZ]MINMESH: to define the common variables i[xyz]minmesh
-;       used to define the grid only in a zoomed part of the original
-;       grid. Defaut values are 0L
-;
-;       [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh
-;       used to define the grid only in a zoomed part of the original
-;       grid. Defaut values are jp[ijk]glo-1
-;
-;       /xyindex: to define the x/y axis with index instead of using
-;       the values contained in X/YAXISNAME. 
-;       x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 
-;       this forces key_onearth = 0
-;
-;       /zindex: to define the z axis with index instead of using
-;       the values contained in ZAXISNAME. 
-;       zaxis = keyword_set(start1) + findgen(jpk) 
-;
-; OUTPUTS:none, except the grid parameters of the common.pro
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:change the grid parameters of the common.pro
-;
-; RESTRICTIONS:
+; @param NCFILEIN {in}{required}
+; A string giving the name of the NetCdf file
+;
+; @keyword INVMASK
+; To inverse the mask: mask = 1-mask
+;
+; @keyword MASKNAME
+; A string giving the name of the variable in the file 
+; that contains the land/sea mask
+;
+; @keyword MISSING_VALUE
+; To define (or redifine if the attribute is
+; already existing) the missing values used with USEASMASK
+; keyword
+;
+; @keyword START1
+; Index the axis from 1 instead of 0 when using
+; /xyindex and/or zindex
+;
+; @keyword USEASMASK
+; A string giving the name of the variable in the file 
+; that will be used to build the land/sea mask. In this case the
+; mask is based on the first record (if record dimension
+; exists). The mask is build according to :
+;    1 the keyword missing_value if existing
+;    2 the attribute 'missing_value' if existing
+;    3 NaN values if existing
+;
+; @keyword XAXISNAME
+; A string giving the name of the variable in the file 
+; that contains the [xyz]axis. 
+; for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'.
+;      
+; @keyword YAXISNAME
+; A string giving the name of the variable in the file 
+; that contains the [xyz]axis. 
+; for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'.
+;
+; @keyword ZAXISNAME
+; A string giving the name of the variable in the file 
+; that contains the [xyz]axis. 
+; for Z axis, default name must be 'z', 'level', 'lev', 'depth...'
+;
+; @keyword XYINDEX
+; To define the x/y axis with index instead of using
+; the values contained in X/YAXISNAME. 
+; x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 
+; this forces key_onearth = 0
+;
+; @keyword ZINDEX
+; To define the z axis with index instead of using
+; the values contained in ZAXISNAME. 
+; zaxis = keyword_set(start1) + findgen(jpk) 
+; 
+; @keyword _EXTRA
+; Used to pass your keywords/
+;
+; @uses
+; common.pro
+;
+; @restrictions
+; Change the grid parameters of the common.pro
+;
+; @restrictions
 ; the file must contain an x and an y axis. (1 ou 2 dimentional array)
 ;
-; EXAMPLE: IDL> initncdf,'toto.nc',glam=[-180,180]
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @examples
+;  IDL> initncdf,'toto.nc',glam=[-180,180]
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      8 May 2002
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------