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

Timestamp:

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

Author:

pinsard

Message:

improvements of Interpolation/*.pro header

File:

• trunk/SRC/Interpolation/inquad.pro (modified) (12 diffs)

trunk/SRC/Interpolation/inquad.pro

@@ -1 +1 @@
 ;+
-; @file_comments to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4)
+; @file_comments 
+; to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4)
 ;
 ; @categories grid manipulation
@@ -6 +7 @@
 ; @param x {in}{required}
 ; @param 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. 
+;  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.
 ;
 ; @param x1 {in}{required}
@@ -17 +18 @@
 ; @param x4 {in}{required}
 ; @param y4 {in}{required}
-;  the coordinates of the quadrilateral given in the CLOCKWISE order. 
+;  the coordinates of the quadrilateral given in the CLOCKWISE order.
 ;  Scalar or array.
 ;
-; @keyword /DOUBLE use double precision to perform the computation 
-;
-; @keyword /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
 ;    related to longitude-latitude coordinates are managed
-;    automatically. 
+;    automatically.
 ;
 ; @keyword ZOOMRADIUS {default=4}
@@ -32 +33 @@
 ;    zoomradius degree where we look for the the quadrilateral which
 ;    contains the (x,y) point) used for the satellite projection
-;    when /onsphere is activated. 
-;    4 seems to be the minimum which can be used. 
+;    when /ONSPHERE is activated.
+;    4 seems to be the minimum which can be used.
 ;    Can be increase if the cell size is larger than 5 degrees.
-;   
-; @keyword /NOPRINT to suppress the print messages.
+;
+; @keyword NOPRINT to suppress the print messages.
 ;
 ; @keyword NEWCOORD
@@ -45 +46 @@
 ;    quadrilateral number j with (0 <= j <= n_elements(x0)-1)
 ;
-; @restrictions I think degenerated quadrilateral (e.g. flat of
-; twisted) is not work. This has to be tested.
-;
-; @examples 
+; @restrictions
+; I think degenerated quadrilateral (e.g. flat of twisted) is not work.
+; This has to be tested.
+;
+; @examples
 ;
 ; IDL> x = 1.*[1, 2, 6, 7, 3]
@@ -70 +72 @@
 ;      Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;      August 2003
-;      Based on Convert_clic_ij.pro written by Gurvan Madec 
+;      Based on Convert_clic_ij.pro written by Gurvan Madec
 ;
 ; @version $Id$
@@ -100 +102 @@
     x3 = x3 MOD 360
     x4 = x4 MOD 360
-; save !map 
+; save !map
     save = {map:!map, x:!x, y:!y, z:!z, p:!p}
-; do a satellite projection 
+; do a satellite projection
     IF NOT keyword_set(zoomradius) THEN zoomradius = 4
     map_set, y[0], x[0], 0, /satellite, sat_p = [1+zoomradius*20/6371.229, 0, 0], /noerase, /iso, /noborder
 ; use normal coordinates to reject cells which are out of the projection.
-    tmp  = convert_coord(x, y, /DATA, /TO_NORMAL, DOUBLE = double) 
-    tmp1 = convert_coord(x1, y1, /DATA, /TO_NORMAL, DOUBLE = double) 
-    tmp2 = convert_coord(x2, y2, /DATA, /TO_NORMAL, DOUBLE = double) 
-    tmp3 = convert_coord(x3, y3, /DATA, /TO_NORMAL, DOUBLE = double) 
-    tmp4 = convert_coord(x4, y4, /DATA, /TO_NORMAL, DOUBLE = double) 
+    tmp  = convert_coord(x, y, /DATA, /TO_NORMAL, DOUBLE = double)
+    tmp1 = convert_coord(x1, y1, /DATA, /TO_NORMAL, DOUBLE = double)
+    tmp2 = convert_coord(x2, y2, /DATA, /TO_NORMAL, DOUBLE = double)
+    tmp3 = convert_coord(x3, y3, /DATA, /TO_NORMAL, DOUBLE = double)
+    tmp4 = convert_coord(x4, y4, /DATA, /TO_NORMAL, DOUBLE = double)
 ; remove cell which have one corner with coordinates equal to NaN
     test = finite(tmp1[0, *]+tmp1[1, *]+tmp2[0, *]+tmp2[1, *] $
@@ -150 +152 @@
 ;
     tmp1 = -1 & tmp2 = -1 & tmp3 = -1 & tmp4 = -1
-; remove cells which are obviously bad 
+; remove cells which are obviously bad
     test = (x1 GT x AND x2 GT x AND x3 GT x AND x4 GT x) $
       OR (x1 LT x AND x2 LT x AND x3 LT x AND x4 LT x) $
@@ -179 +181 @@
     ENDIF
 ;
-    nquad = n_elements(good2) 
+    nquad = n_elements(good2)
     x1 = x1[good2]
     y1 = y1[good2]
@@ -196 +198 @@
 ;       *((x-x2)*(y3-y2) GT (x3-x2)*(y-y2)) $
 ;       *((x-x3)*(y4-y3) GT (x4-x3)*(y-y3)) $
-;       *((x-x4)*(y1-y4) GE (x1-x4)*(y-y4)) 
+;       *((x-x4)*(y1-y4) GE (x1-x4)*(y-y4))
 ;
 ; computation of test without any do loop for ntofind points (x,y) and
@@ -202 +204 @@
 ; test dimensions are (ntofind, nquad)
 ; column i of test corresponds to the intersection of point i with all
-; quadirlateral. 
-; row j of test corresponds to all the points localized in cell j 
+; quadirlateral.
+; row j of test corresponds to all the points localized in cell j
   test = $
 ; (x-x1)
@@ -277 +279 @@
         ENDIF
         return,  -1
-      END 
+      END
       n_elements(found) GT ntofind:BEGIN
         IF NOT keyword_set(noprint) THEN print, 'The point is in more than one cell'
-      END 
+      END
       ELSE:
     ENDCASE
   ENDIF ELSE BEGIN
-; if ntofind GT 1, found must be sorted 
+; if ntofind GT 1, found must be sorted
 ; i position of found. this corresponds to one x,y point
     forsort = found MOD ntofind