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

trunk/SRC/Interpolation/inquad.pro

@@ -1 +1 @@
 ;+
-; NAME:inquad
-;
-; PURPOSE: to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4)
-;
-; CATEGORY:grid manipulation
-;
-; CALLING SEQUENCE:
+; @file_comments to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4)
+;
+; @categories grid manipulation
+;
+; @examples 
 ;
 ;     res = inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4)
 ;
-; INPUTS:
-;
-;     x,y: the coordinates of the point we want to know where it
+;     @param x y {in}{required}  the coordinates of the point we want to know where it
 ;     is. Must be a scalar if /onsphere activated else can be scalar
 ;     or array. 
 ;
-;     x1, y1, x2, y2, x3, y3, x4, y4: the coordinates of the
+;     @param x1 y1 x2 y2 x3 y3 x4 y4 {in}{required}  the coordinates of the
 ;     quadrilateral given in the CLOCKWISE order. Scalar or array.
 ;
-; KEYWORD PARAMETERS:
-;
-;    /DOUBLE: use double precision to perform the computation 
-;
-;    /ONSPHERE: to specify that the quadilateral are on a sphere and
+;
+; @keyword    /DOUBLE use double precision to perform the computation 
+;
+; @keyword    /ONSPHERE to specify that the quadilateral are on a sphere and
 ;    that teir coordinates are longitude-latitude coordinates. In this
 ;    case, est-west periodicity, poles singularity and other pbs
@@ -29 +24 @@
 ;    automatically. 
 ;
-;    ZOOMRADIUS:the zoom (circle centred on the (x,y) with a radius of
+; @keyword    ZOOMRADIUS :the zoom (circle centred on the (x,y) with a radius of
 ;    zoomradius degree where we look for the the quadrilateral which;    contains the (x,y) point) used for the satellite projection
 ;    when /onsphere is activated. Default is 4 and seems to be the
@@ -35 +30 @@
 ;    larger than 5 degrees.
 ;   
-;    /NOPRINT: to suppress the print messages.
-;
-; OUTPUTS:
-;
-;    res, a n element vector. Where n is the number of elements of
+; @keyword    /NOPRINT to suppress the print messages.
+;
+; @returns
+;    a n element vector. Where n is the number of elements of
 ;    x. res[i]=j means that the point number i is located in the
 ;    quadrilateral number j with (0 <= j <= n_elements(x0)-1)
 ;
-; 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 
 ;
 ;       x = 1.*[1, 2, 6, 7, 3]
@@ -69 +59 @@
 ;      On a sphere see clickincell.pro...
 ;
-; MODIFICATION HISTORY:
-;      Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+;      Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;      August 2003
 ;      Based on Convert_clic_ij.pro written by Gurvan Madec 
@@ -192 +182 @@
 ; the point is inside the quadilateral if test eq 1
 ; with test equal to:
-;     test = ((x-x1)*(y2-y1) GE (x2-x1)*(y-y1)) $       
+;     test = ((x-x1)*(y2-y1) GE (x2-x1)*(y-y1)) $
 ;       *((x-x2)*(y3-y2) GT (x3-x2)*(y-y2)) $
 ;       *((x-x3)*(y4-y3) GT (x4-x3)*(y-y3)) $