Changeset 136 for trunk/SRC/Interpolation/fromreg.pro

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

File:

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

trunk/SRC/Interpolation/fromreg.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; interpolate data from a "regular/rectangular grid" to any grid.
 ;   2 methods availables: bilinear and imoms3
@@ -9 +9 @@
 ; @categories interpolation
 ;
-; @param method {in}{required}  a string defining the interpolation method.
-;            must be 'bilinear' or 'imoms3'
-; @param datain {in}{required}  a 2D array the input data to interpolate
-; @param lonin {in}{optional}  1D or 2D array defining the longitude of the input data
-; @param latin {in}{optional}  1D or 2D array defining the latitude of the input data
-; @param lonout {in}{optional}  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 method {in}{required}
+; a string defining the interpolation method.
+; must be 'bilinear' or 'imoms3'
+;
+; @param datain {in}{required}
+; a 2D array the input data to interpolate
+;
+; @param lonin {in}{optional}
+; 1D or 2D array defining the longitude of the input data
+;
+; @param latin {in}{optional}
+; 1D or 2D array defining the latitude of the input data
+;
+; @param lonout {in}{optional}
+; 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
 ;
 ; @keyword WEIG (see ADDR)
 ; @keyword ADDR 2D arrays, weig and addr are the weight and addresses used to
-;     perform the interpolation:
+; perform the interpolation:
 ;          dataout = total(weig*datain[addr], 1)
 ;          dataout = reform(dataout, jpio, jpjo, /over)
-;     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
-;     case, lonin, latin, lonout and latout are not necessary.
+; 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
+; case, lonin, latin, lonout and latout are not necessary.
 ;
 ; @keyword NONORTHERNLINE
@@ -32 +43 @@
 ; of the input data when perfoming the interpolation.
 ;
-; @returns 2D array the interpolated data
+; @returns
+; 2D array the interpolated data
 ;
 ; @restrictions