]> Pileus Git - ~andy/rsl/blob - doc/RSL_get_ray_above-below.html
RSL v1.44
[~andy/rsl] / doc / RSL_get_ray_above-below.html
1 <head>
2 </head>
3
4 <body>
5 <a HREF="index.html"> <IMG SRC="rsl.gif"> </a>
6 <hr>
7
8
9 <h1>RSL_get_ray_above<br>
10 RSL_get_ray_below</h1>
11
12 <hr>
13
14 <h3>Synopsis</h3>
15 <b>#include &quot;rsl.h&quot;</b> <br>
16 <a href=RSL_ray_struct.html>Ray</a> *RSL_get_ray_above(<a href=RSL_volume_struct.html>Volume</a> *v, <a href=RSL_ray_struct.html>Ray</a> *current_ray); <br>
17 <a href=RSL_ray_struct.html>Ray</a> *RSL_get_ray_below(<a href=RSL_volume_struct.html>Volume</a> *v, <a href=RSL_ray_struct.html>Ray</a> *current_ray); 
18
19 <h3>
20 <hr>
21
22 <p>Description</h3>
23 Returns a Ray that is either above or below the <b>current_ray</b>. The elevation angle is extracted from the current_ray and 1.0 is added or subtracted to/from it and the function <a href=RSL_get_sweep.html>RSL_get_sweep</a> is called. This algorithm is simple and may not be robust enough; it has already been inadequate for the GT quality control. 
24 <hr>
25
26 <h3>Return value</h3>
27 Upon successful completion, a pointer to the Ray structure is returned. Otherwise, a NULL pointer is returned. 
28 <hr>
29
30 <h3>See also</h3>
31 <a href=RSL_get_ray_from_sweep.html>RSL_get_ray_from_sweep</a>, <a href=RSL_get_first_ray_of.html>RSL_get_first_ray_of_sweep</a>, <a href=RSL_get_first_ray_of.html>RSL_get_first_ray_of_volume</a>, <a href=RSL_get_ray.html>RSL_get_ray,</a> <a href=RSL_get_sweep.html>RSL_get_sweep</a>.
32 <hr>
33
34 <p>Author: <a href=john.merritt.html>John H. Merritt</a> 
35 </body>