Changeset 163 for trunk/SRC/Interpolation/get_gridparams.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Interpolation/get_gridparams.pro (modified) (3 diffs)

trunk/SRC/Interpolation/get_gridparams.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; 1) extract from a NetCDF file the longitude, latidude, and their dimensions
+; 1) extract from a NetCDF file the longitude, latitude, and their dimensions
 ; and make sure it is 1D or 2D arrays
 ;
@@ -24 +24 @@
 ; 1)
 ; @param in1 {in}{required}
-; the name of the netcdf file
+; Case 1: the name of the netcdf file
+; Case 2: 1d or 2D arrays defining longitudes and latitudes.
+; Out: the variable that will contain the longitudes
 ;
 ; @param in2 {in}{required}
-; the name of the variable that contains the longitude in the NetCDF file
+; Case 1: the name of the variable that contains the longitude in the NetCDF file
+; Case 2: 1d or 2D arrays defining longitudes and latitudes.
+;         Note that these arrays are also outputs and can therefore be modified.
+; Out: the variable that will contain the latitudes
 ;
 ; @param in3 {in}{required}
-; the name of the variable that contains the latitude in the NetCDF file
+; Case 1: the name of the variable that contains the latitude in the NetCDF file
+; Case 2: the number of points in the longitudinal direction.
 ;
 ; @param in4 {out}
-; the number of points in the longitudinal direction
+; Case 1: the number of points in the longitudinal direction
+; Case 2: the number of points in the latitudinal direction
 ;
 ; @param in5 {out}
-; the number of points in the latitudinal direction
+; Case 1: the number of points in the latitudinal direction
+; Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
+; arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
+; grid must be regular (each longitudes must be the same for all latitudes
+; and each latitudes should be the same for all longitudes).
 ;
 ; @param in6 {out}
@@ -46 +57 @@
 ; @param in8 {out}
 ; 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
-;
-; or
-;
-; 2)
-; @param in1 {in}{required}
-; 1d or 2D arrays defining longitudes and latitudes.
-;
-; @param in2 {in}{required}
-; 1d or 2D arrays defining longitudes and latitudes.
-; Note that these arrays are also outputs and can therefore be modified.
-;
-; @param in1 {out}
-; the variable that will contain the longitudes
-;
-; @param in2 {out}
-; the variable that will contain the latitudes
-;
-; @param in3 {in}
-; the number of points in the longitudinal direction
-;
-; @param in4 {in}
-; the number of points in the latitudinal direction
-;
-; @param in5 {in}
-; 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
-; arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
-; grid must be regular (each longitudes must be the same for all latitudes
-; and each latitudes should be the sae for all longitudes).
 ;
 ; @keyword DOUBLE