Changeset 163 for trunk/SRC/Interpolation/fromreg.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/fromreg.pro (modified) (3 diffs)

trunk/SRC/Interpolation/fromreg.pro

@@ -3 +3 @@
 ; @file_comments
 ; interpolate data from a "regular/rectangular grid" to any grid.
-;   2 methods availables: bilinear and imoms3
-;   A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have
+;   2 methods available: bilinear and imoms3
+;   A "regular/rectangular grid" is defined as a grid for which each longitudes lines have
 ;   the same latitude and each latitudes columns have the same longitude.
 ;
@@ -10 +10 @@
 ; Interpolation
 ;
-; @param method {in}{required}
+; @param method {in}{required}{type=string}
 ; a string defining the interpolation method.
 ; must be 'bilinear' or 'imoms3'
 ;
-; @param datain {in}{required}
+; @param datain {in}{required}{type=2d array}
 ; a 2D array the input data to interpolate
 ;
-; @param lonin {in}{optional}
+; @param lonin {in}{optional}{type=1d or 2d array}
 ; 1D or 2D array defining the longitude of the input data
 ;
-; @param latin {in}{optional}
+; @param latin {in}{optional}{type=1d or 2d array}
 ; 1D or 2D array defining the latitude of the input data
 ;
-; @param lonout {in}{optional}
+; @param lonout {in}{optional}{type=1d or 2d array}
 ; 1D or 2D array defining the longitude of the output data
 ;
-; @param latout {in}{required}
+; @param latout {in}{required}{type=1d or 2d array}
 ; 1D or 2D array defining the latitude of the output data
 ;
-; @keyword WEIG (see ADDR)
-; @keyword ADDR 2D arrays, weig and addr are the weight and addresses used to
+; @keyword WEIG {type=2d array}
+; (see ADDR)
+;
+; @keyword ADDR {type=2d array}
+; 2D arrays, weig and addr are the weight and addresses used to
 ; perform the interpolation:
 ;          dataout = total(weig*datain[addr], 1)
@@ -36 +39 @@
 ; Those keywords can be set to named variables (that are undefined or equal to 0) into which the
 ; values will be copied when the current routine exits. Next, they can be used to perform
-; the interpolation whithout computing again those 2 parameters. In that
+; the interpolation without computing again those 2 parameters. In that
 ; case, lonin, latin, lonout and latout are not necessary.
 ;
 ; @keyword NONORTHERNLINE
+; activate if you don't want to take into account the northern line
+; of the input data when performing the interpolation.
+;
 ; @keyword NOSOUTHERNLINE
-; activate if you don't want to take into account the northen/southern line
-; of the input data when perfoming the interpolation.
+; activate if you don't want to take into account the southern line
+; of the input data when performing the interpolation.
 ;
 ; @returns