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

Timestamp:

06/12/06 10:29:56 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Interpolation *.pro files for better idldoc output

File:

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

trunk/SRC/Interpolation/fromreg.pro

@@ -1 +1 @@
 ;+
-; NAME: fromreg
 ;
-; PURPOSE: interpolate data from a "regular/rectangular grid" to any grid.
+; @file_comments interpolate data from a "regular/rectangular grid" to any grid.
 ;   2 metods availables: bilinear and imoms3 
 ;   A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have 
 ;   the same latitude and each latitudes columns have the same longitude.
 ;   
-; CATEGORY:interpolation
+; @categories interpolation
 ;
-; CALLING SEQUENCE: dataout = fromreg(method, datain [, lonin, latin, lonout, latout])
+; @examples  
+; dataout = fromreg(method, datain [, lonin, latin, lonout, latout])
 ;
-; INPUTS:
-;    method: a string defining the interpolation method. 
+;    @param method {in}{required}  a string defining the interpolation method. 
 ;            must be 'bilinear' or 'imoms3'
-;    datain: a 2D array the input data to interpolate
-;    lonin and latin: longitude/latitude of the input data. optionals if
+;    @param datain {in}{required}  a 2D array the input data to interpolate
+;    @param lonin latin {in}{required}  longitude/latitude of the input data. optionals if
 ;            WEIG and ADDR keywords used.
-;    lonout and latout: longitude/latitude of the output data. optionals if
+;    @param lonout latout {in}{required}  longitude/latitude of the output data. optionals if
 ;            WEIG and ADDR keywords used.
 ;
-; KEYWORD PARAMETERS: 
-;
-;     WEIG, ADDR: 2D arrays, weig and addr are the weight and addresses used to
+; @keyword     WEIG, ADDR 2D arrays, weig and addr are the weight and addresses used to
 ;     perform the interpolation:
 ;          dataout = total(weig*datain[addr], 1)
@@ -31 +28 @@
 ;     case, lonin, latin, lonout and latout are not necessary.
 ;
-;     /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into
+; @keyword     /NONORTHERNLINE and /NOSOUTHERNLINE activate if you don't whant to take into
 ;          account the northen/southern line of the input data when perfoming the
 ;          interpolation.
 ;
-; OUTPUTS: 2D array: the interpolated data
+; @returns 2D array: the interpolated data
 ;
-; COMMON BLOCKS: none
+; @restrictions We supposed the data are located on a sphere, with a 
+; periodicity along the longitude.
 ;
-; SIDE EFFECTS: ?
-;
-; RESTRICTIONS:We supposed the data are located on a sphere, with a periodicity along
-;              the longitude.
-;
-; EXAMPLE: 
+; @examples  
 ;  
 ;  topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit)
@@ -54 +47 @@
 ;  t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b)
 ;
-; MODIFICATION HISTORY:
-;  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
+; @history
+;  November 2005: Sebastien Masson (smasson\@lodyc.jussieu.fr) 
 ; 
 ;-