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

Timestamp:

08/30/07 14:44:23 (17 years ago)

Author:

smasson

Message:

bugfix for interpolation from ORCA2 without mask

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, latitude, and their dimensions
+; Case 1: extract from a NetCDF file longitude and latitude arrays, their dimensions
 ; and make sure it is 1D or 2D arrays
 ;
-; or
-; 2) given longitude and latitude arrays, get their dimensions and make
+; Case 2: given longitude and latitude arrays, get their dimensions and make
 ; sure they are 1D or 2D arrays
 ;
@@ -14 +13 @@
 ; @examples
 ;
-; 1)
-; IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions
-;
-; or
-;
-; 2)
+; Case 1:
+; IDL> get_gridparams, file name/id, lonname, latname, lon, lat, jpi, jpj, n_dimensions
+;
+; Case 2:
 ; IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions
 ;
 ; @param in1 {in}{required}
-; 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
+; Case 1: name or the id (returned by ncdf_open) of the netcdf file
+; Case 2: 1D or 2D arrays defining longitudes, will be forced to have
+;         n_dimensions dimensions when returned
 ;
 ; @param in2 {in}{required}
-; 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}
-; 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.
+; Case 1: name of the variable containing the longitude in the NetCDF file
+; Case 2: 1D or 2D arrays defining latitudes, will be forced to have
+;         n_dimensions dimensions when returned
+;
+; @param in3 
+; Case 1: name of the variable containing the latitude in the NetCDF file
+; Case 2: returned number of points in longitudinal direction.
 ;
 ; @param in4 {out}
-; Case 1: the number of points in the longitudinal direction
-; Case 2: the number of points in the latitudinal direction
-;
-; @param in5 {out}
-; 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 longitude must be the same for all latitudes
-; and each latitude should be the same for all longitudes).
+; Case 1: returned longitudes array, with n_dimensions dimensions
+; Case 2: returned number of points in latitudinal direction
+;
+; @param in5
+; Case 1: returned latitudes array, with n_dimensions dimensions 
+; Case 2: input scalar (1 or 2) to specify if lon and lat should be returned 
+;         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
+;         regular (longitude and latitudes can be described as 1D arrays).
 ;
 ; @param in6 {out}
-; the variable that will contain the longitudes
+; Case 1: returned number of points in longitudinal direction.
 ;
 ; @param in7 {out}
-; the variable that will contain the latitudes
-;
-; @param in8 {out}
-; 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
-;
-; @keyword DOUBLE
-; use double precision to perform the computation
+; Case 1: returned number of points in latitudinal direction
+;
+; @param in8 {in}
+; Case 1: input scalar (1 or 2) to specify if lon and lat should be returned 
+;         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
+;         regular (longitude and latitudes can be described as 1D arrays).
+;
+; @keyword DOUBLE {default=0}{type=scalar: 0 or 1}
+; activate to force double precision for lon/lat arrays
 ;
 ; @examples
@@ -84 +81 @@
     8:BEGIN
 ; get longitude and latitude
-      IF file_test(in1) EQ 0 THEN BEGIN
-        ras = report('file ' + in1 + ' does not exist')
-        stop
-      ENDIF
-      cdfido = ncdf_open(in1)
+      IF size(in1, /type) EQ 7 THEN BEGIN
+        IF file_test(in1) EQ 0 THEN BEGIN
+          ras = report('file ' + in1 + ' does not exist')
+          stop
+        ENDIF
+        cdfido = ncdf_open(in1)
+      ENDIF ELSE cdfido = in1
       ncdf_varget, cdfido, in2, lon
       ncdf_varget, cdfido, in3, lat
-      ncdf_close, cdfido
+      IF size(in1, /type) EQ 7 THEN ncdf_close, cdfido
       n_dimensions = in8
     END