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

Timestamp:

07/06/06 16:10:25 (18 years ago)

Author:

pinsard

Message:

improvements of Interpolation/*.pro header

File:

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

trunk/SRC/Interpolation/fromreg.pro

@@ -1 +1 @@
 ;+
 ;
-; @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 
+; @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
 ;   the same latitude and each latitudes columns have the same longitude.
-;   
+;
 ; @categories interpolation
 ;
-; @param method {in}{required}  a string defining the interpolation method. 
+; @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
@@ -26 +27 @@
 ;     case, lonin, latin, lonout and latout are not necessary.
 ;
-; @keyword /NONORTHERNLINE 
-; @keyword /NOSOUTHERNLINE 
-; activate if you don't whant to take into account the northen/southern line 
+; @keyword NONORTHERNLINE
+; @keyword NOSOUTHERNLINE
+; activate if you don't want to take into account the northen/southern line
 ; of the input data when perfoming the interpolation.
 ;
 ; @returns 2D array the interpolated data
 ;
-; @restrictions We supposed the data are located on a sphere, with a 
-; periodicity along the longitude.
+; @restrictions
+; We supposed the data are located on a sphere, with a periodicity along the
+; longitude.
 ;
-; @examples  
-;  
-;  IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit)
+; @examples
 ;
-;  or 
+; IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit)
 ;
-;  IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b)
-;  IDL> help, a, b
-;  IDL> t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b)
+;  or
+;
+; IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b)
+; IDL> help, a, b
+; IDL> t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b)
 ;
 ; @history
-;  November 2005: Sebastien Masson (smasson\@lodyc.jussieu.fr) 
+;  November 2005: Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;
 ; @version $Id$
@@ -60 +62 @@
                   , NOSOUTHERNLINE = nosouthernline
 ;
-  compile_opt idl2, strictarrsubs 
+  compile_opt idl2, strictarrsubs
 ;
 ;---------------
@@ -81 +83 @@
       'bilinear':compute_fromreg_bilinear_weigaddr, alon, alat, olon, olat, weig, addr, NONORTHERNLINE = nonorthernline, NOSOUTHERNLINE = nosouthernline
       'imoms3':  compute_fromreg_imoms3_weigaddr,   alon, alat, olon, olat, weig, addr, NONORTHERNLINE = nonorthernline, NOSOUTHERNLINE = nosouthernline
-      ELSE:BEGIN 
+      ELSE:BEGIN
         print, ' unknown interpolation method... we stop'
         stop