Changeset 101 for trunk/SRC/Interpolation/quadrilateral2square.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/quadrilateral2square.pro (modified) (4 diffs)

trunk/SRC/Interpolation/quadrilateral2square.pro

@@ -1 +1 @@
 ;+
-; NAME:quadrilateral2square
 ;
-; PURPOSE:warm (or map) an arbitrary quadrilateral onto a unit square 
+; @file_comments warm (or map) an arbitrary quadrilateral onto a unit square 
 ; according to the 4-point correspondences:
 ;       (x0,y0) -> (0,0)
@@ -13 +12 @@
 ; mappings. see ref. bellow.
 ;
-; CATEGORY:image/grid manipulation
+; @categories image, grid manipulation
 ;
-; CALLING SEQUENCE:
+; @examples 
 ;
 ;     res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3,xin,yin)
 ; 
-; INPUTS:
-;
-;     x0,y0,x1,y1,x2,y2,x3,y3 the coordinates of the quadrilateral
+;     @param x0in {in}{required}  the coordinates of the quadrilateral
+;     @param y0in {in}{required}  the coordinates of the quadrilateral
+;     @param x1in {in}{required}  the coordinates of the quadrilateral
+;     @param y1in {in}{required}  the coordinates of the quadrilateral
+;     @param x2in {in}{required}  the coordinates of the quadrilateral
+;     @param y2in {in}{required}  the coordinates of the quadrilateral
+;     @param x3in {in}{required}  the coordinates of the quadrilateral
+;     @param y3in  {in}{required}  the coordinates of the quadrilateral
 ;     (see above for correspondance with the unit square). Can be
 ;     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are
 ;     given in the anticlockwise order.
 ;
-;     xin,yin:the coordinates of the point(s) for which we want to do the
+;     @param xxin {in}{required} the coordinates of the point(s) for which we want to do the
+;     mapping. Can be scalar or array.
+;     @param yyin {in}{required} the coordinates of the point(s) for which we want to do the
 ;     mapping. Can be scalar or array.
 ;
-; KEYWORD PARAMETERS:
-;
-;    /DOUBLE: use double precision to perform the computation 
-;
-; OUTPUTS:
+; @returns
 ;
 ;     (2,n) array: the new coodinates (xout, yout) of the (xin,yin)
@@ -41 +43 @@
 ;     elements of xin.
 ;
-; COMMON BLOCKS:none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS: I think degenerated quadrilateral (e.g. flat of
+; @restrictions I think degenerated quadrilateral (e.g. flat of
 ; twisted) is not work. This has to be tested.
 ;
-; EXAMPLE:
+; @examples 
 ;
 ; IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1
@@ -60 +58 @@
 ; IDL> tracegrille, reform(inorg[0,*],11,11), reform(inorg[1,*],11,11),color=indgen(12)*20
 ;
-; MODIFICATION HISTORY:
-;      Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+;      Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;      August 2003
 ;      Based on "Digital Image Warping" by G. Wolberg