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

Timestamp:

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

Author:

pinsard

Message:

improvements of Interpolation/*.pro header

File:

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

trunk/SRC/Interpolation/cutsegment.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments cut p segments into p*n equal parts
+; @file_comments 
+; cut p segments into p*n equal parts
 ;
 ; @categories basic work
@@ -13 +14 @@
 ; @param n {in}{required} the number of pieces we want to cut each segment
 ;
-; @keyword /endpoints see ouputs
+; @keyword ENDPOINTS see ouputs
 ;
-; @keyword /onsphere to specify that the points are located on a
+; @keyword ONSPHERE to specify that the points are located on a
 ;         sphere. In this case, x and y corresponds to longitude and
 ;         latitude in degrees.
 ;
 ; @returns
-;        default: a 3d array (2,n,p) that gives the coordinates of the
-;        middle of the cutted segments.
-;        if /endpoints, a 3d array (2,n+1,p) that gives the
-;        coordinates of the endpoints of the cutted segments.
+;  - default: a 3d array (2,n,p) that gives the coordinates of the
+;  middle of the cutted segments.
+;  - if /ENDPOINTS, a 3d array (2,n+1,p) that gives the
+;  coordinates of the endpoints of the cutted segments.
 ;
-; @examples 
+; @examples
 ;
-;  IDL> x0=[2,5]
-;  IDL> y0=[5,1]
-;  IDL> x1=[9,3]
-;  IDL> y1=[1,8]
-;  IDL> res=cutsegment(x0, y0, x1, y1, 10)
-;  IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
-;  IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
-;  IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
-;  IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
-;  IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
+; IDL> x0=[2,5]
+; IDL> y0=[5,1]
+; IDL> x1=[9,3]
+; IDL> y1=[1,8]
+; IDL> res=cutsegment(x0, y0, x1, y1, 10)
+; IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
+; IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
+; IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
+; IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
+; IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
 ;
 ; @history
@@ -45 +46 @@
 ;
 ;-
-FUNCTION cutsegment, x0, y0, x1, y1, n, endpoints = endpoints, onsphere = onsphere
+FUNCTION cutsegment, x0, y0, x1, y1, n, ENDPOINTS = endpoints, ONSPHERE = onsphere
 ;
   compile_opt idl2, strictarrsubs
 ;
 ; number of segment
-  nseg = n_elements(x0) 
+  nseg = n_elements(x0)
 ; number of point to find on each segment
-  n2find = n+keyword_set(endpoints) 
+  n2find = n+keyword_set(endpoints)
 ;
   IF keyword_set(onsphere) THEN BEGIN