source: trunk/SRC/Interpolation/cutsegment.pro @ 101

Last change on this file since 101 was 101, checked in by pinsard, 18 years ago

start to modify headers of Interpolation *.pro files for better idldoc output

  • Property svn:executable set to *
File size: 3.3 KB
Line 
1;+
2;
3; @file_comments cut p segments into p*n equal parts
4;
5; @categories basic work
6;
7; @examples 
8; res = cutsegment(x0, y0, x1, y1, n)
9;
10;         @param x0,y0 and x1,y1  {in}{required}  1d arrays of p elements, the coordinates of
11;         the endpoints of the p segmements
12;         @param  n {in}{required}  the number of pieces we want to cut each segment
13;
14;
15; @keyword         /endpoints see ouputs
16;
17; @keyword         /onsphere to specify that the points are located on a
18;         sphere. In this case, x and y corresponds to longitude and
19;         latitude in degrees.
20;
21; @returns
22;        defaut: a 3d array (2,n,p) that gives the coordinates of the
23;        middle of the cutted segments.
24;        if /endpoints, a 3d array (2,n+1,p) that gives the
25;        coordinates of the endpoints of the cutted segments.
26;
27; @examples
28;
29;  IDL> x0=[2,5]
30;  IDL> y0=[5,1]
31;  IDL> x1=[9,3]
32;  IDL> y1=[1,8]
33;  IDL> res=cutsegment(x0, y0, x1, y1, 10)
34;  IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata
35;  IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]]
36;  IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3
37;  IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]]
38;  IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
39;
40; @history
41;           S. Masson (smasson\@lodyc.jussieu.fr)
42;           July 5th, 2002
43;-
44FUNCTION cutsegment, x0, y0, x1, y1, n, endpoints = endpoints, onsphere = onsphere
45; number of segment
46  nseg = n_elements(x0)
47; number of point to find on each segment
48  n2find = n+keyword_set(endpoints)
49;
50  IF keyword_set(onsphere) THEN BEGIN
51; save the inputs arrays
52    x0in = temporary(x0)
53    y0in = temporary(y0)
54    x1in = temporary(x1)
55    y1in = temporary(y1)
56    sp_cood = [transpose(x0in[*]),transpose(y0in[*]),replicate(1, 1, nseg)]
57    rect_coord = CV_COORD(FROM_SPHERE = temporary(sp_cood), /TO_RECT, /DEGREES)
58    x0 = rect_coord[0, *]
59    y0 = rect_coord[1, *]
60    z0 = rect_coord[2, *]
61    rect_coord = -1 ;free memory
62    sp_cood = [transpose(x1in[*]),transpose(y1in[*]),replicate(1, 1, nseg)]
63    rect_coord = CV_COORD(FROM_SPHERE = temporary(sp_cood), /TO_RECT, /DEGREES)
64    x1 = rect_coord[0, *]
65    y1 = rect_coord[1, *]
66    z1 = rect_coord[2, *]
67    rect_coord = -1 ;free memory
68  ENDIF
69;
70  resx = replicate(1, n2find)#x0[*]
71  resx = temporary(resx)+(1./n*(findgen(n2find) $
72                                +.5*(1-keyword_set(endpoints))))#(x1-x0)[*]
73  resx = (temporary(resx))[*]
74;
75  resy = replicate(1, n2find)#y0[*]
76  resy = temporary(resy)+(1./n*(findgen(n2find) $
77                                +.5*(1-keyword_set(endpoints))))#(y1-y0)[*]
78  resy = (temporary(resy))[*]
79
80  IF keyword_set(onsphere) THEN BEGIN
81    resz = replicate(1, n2find)#z0[*]
82    resz = temporary(resz)+(1./n*(findgen(n2find) $
83                                  +.5*(1-keyword_set(endpoints))))#(z1-z0)[*]
84    resz = (temporary(resz))[*]
85
86    rec_cood = [transpose(temporary(resx)), transpose(temporary(resy)) $
87                , transpose(temporary(resz))]
88    res = CV_COORD(FROM_RECT = temporary(rec_cood), /TO_SPHERE, /DEGREES)
89; restore the input arrays
90    x0 = temporary(x0in)
91    y0 = temporary(y0in)
92    x1 = temporary(x1in)
93    y1 = temporary(y1in)
94  ENDIF ELSE res = [transpose(temporary(resx)), transpose(temporary(resy))]
95
96  res = reform(res[0:1, *], 2, n2find, nseg, /overwrite)
97
98  RETURN, res
99END
Note: See TracBrowser for help on using the repository browser.