Pileus Git - ~andy/rsl/blob - doc/RSL_get_slice_from_cube.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_slice_from_cube</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b> <br>
  15 <b><a href=RSL_carpi_struct.html>Slice</a> *RSL_get_slice_from_cube(</b><b><a href=RSL_cube_struct.html>Cube</a> *cube, int x, int y, int z);</b>
  16
  17 <h3>
  18 <hr>Description</h3>
  19 Given a Cube structure, extract one slice from it. x, y and z define the plane of the required slice. Two of the three parameters must equal -1 and the third must be nonnegative; eg, the vertical plane y=100 is specified by the parameters x=-1, y=100, z=-1. Assumes valid ranges for x, y, z are: <br>
  20 0 &lt;= x &lt;= nx-1, 0 &lt;= y &lt;= ny-1, 1 &lt;= z &lt;= nz<br>
  21 nx, ny and nz specify the dimensions of the cube structure and are members of it. The range of z starts at 1 , since a cappi (or carpi) at height z=0 makes no sense.
  22 <hr>
  23
  24 <h3>Return value</h3>
  25 Upon successful completion, a pointer to the appropriate structure is returned. Otherwise, a NULL pointer is returned and errno is set.
  26 <hr>
  27
  28 <h3>See also</h3>
  29 <a href=RSL_volume_to_cube.html>RSL_volume_to_cube</a>
  30
  31 <p>
  32 <hr>Author: <a href=mike.kolander.html>Mike Kolander</a>
  33 </body>