Changeset 121 for trunk/SRC/Interpolation/fromirr.pro

Timestamp:

06/29/06 16:59:33 (18 years ago)

Author:

pinsard

Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

File:

• trunk/SRC/Interpolation/fromirr.pro (modified) (2 diffs)

trunk/SRC/Interpolation/fromirr.pro

@@ -2 +2 @@
 ;
 ; @file_comments interpolate data from an irregular 2D grid to any 2D grid.
-;   Only 1 metod available: bilinear
+;   Only 1 metod available = bilinear
 ;   
 ; @categories interpolation
 ;
-; @examples  
-; dataout = fromirr(method, datain [, lonin, latin, mskin, lonout, latout, mskout])
-;
-;    @param method: {in}{required} a string defining the interpolation method. must be 'bilinear'
-;    @param datain: {in}{required} a 2D array the input data to interpolate
-;    @param lonin: {in}{required} a 2D array defining the longitude of the input data
-;    @param latin: {in}{required} a 2D array defining the latitude of the input data.
-;    @param mskin: {in}{required} a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land)
-;    @param lonout: {in}{required} 1D or 2D array defining the longitude of the output data.
-;    @param latout: {in}{required} 1D or 2D array defining the latitude of the output data.
-;    @param mskout: {in}{required} a 2D array, the land-sea mask of the ouput data (1 on ocean, 0 on land)
+;    @param method {in}{required} a string defining the interpolation method. must be 'bilinear'
+;    @param datain {in}{required} a 2D array the input data to interpolate
+;    @param lonin {in}{optional} a 2D array defining the longitude of the input data
+;    @param latin {in}{optional} a 2D array defining the latitude of the input data.
+;    @param mskin {in}{optional} a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land)
+;    @param lonout {in}{optional} 1D or 2D array defining the longitude of the output data.
+;    @param latout {in}{optional} 1D or 2D array defining the latitude of the output data.
+;    @param mskout {in}{required} a 2D array, the land-sea mask of the ouput data (1 on ocean, 0 on land)
 ;
 ; @keyword WEIG (see ADDR)
@@ -28 +25 @@
 ;     speed-up the interpolation! In that case, lonin, latin, lonout and latout are not necessary.
 ;
-; @returns 2D array: the interpolated data
+; @returns 2D array the interpolated data
 ;
 ; @restrictions We supposed the data are located on a sphere, with a periodicity along