<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkArraySlice Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkArraySlice Class Reference</h1><!-- doxytag: class="vtkArraySlice" --><code>#include <<a class="el" href="a03779.html">vtkArraySlice.h</a>></code>
<p>
<p>
<a href="a07988.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Describes a subset of an N-way array.
<p>
<a class="el" href="a00136.html" title="Describes a subset of an N-way array.">vtkArraySlice</a> describes a subset of a <a class="el" href="a00124.html" title="Abstract interface for N-dimensional arrays.">vtkArray</a> as a set of half-open ranges along each dimension.<p>
Convenience constructors are provided for specifying one, two, and three dimension slices. For higher dimensions, use the default constructor, the <a class="el" href="a00136.html#1d186683d1919887f5993c218f30ff59">SetDimensions()</a> method and operator[] to assign a range along each dimension of a slice.<p>
<a class="el" href="a00136.html" title="Describes a subset of an N-way array.">vtkArraySlice</a> is most commonly used with the <a class="el" href="a01977.html#20eab8ee226510593e2cd5873591ef9c">vtkInterpolate()</a> function, which is used to compute weighted sums of <a class="el" href="a00124.html" title="Abstract interface for N-dimensional arrays.">vtkArray</a> slices.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00124.html" title="Abstract interface for N-dimensional arrays.">vtkArray</a>, vtkRange</dd></dl>
<dl class="user" compact><dt><b>Thanks:</b></dt><dd>Developed by Timothy M. Shead (<a href="mailto:tshead@sandia.gov">tshead@sandia.gov</a>) at Sandia National Laboratories.</dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_1.html#c2_vtk_t_vtkArraySlice">vtkArraySlice (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a03779.html#l00056">56</a> of file <a class="el" href="a03779.html">vtkArraySlice.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#bb58a2e63b6803a57e2b69f1e25b97b6">vtkArraySlice</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#19ee8ec8d2d0955cae41c63aa48ce68e">GetDimensions</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00130.html">vtkArrayExtents</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#7f0de4dbca27a8d10601a6b6fbd727a3">GetExtents</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00127.html">vtkArrayCoordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#9fb01cbdf1cd8e016e4080c3eac08cf9">GetCoordinatesN</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> n) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#1d186683d1919887f5993c218f30ff59">SetDimensions</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> dimensions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00135.html">vtkArrayRange</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#4e1a1d8fdddfb2fd11272f15d9a95a93">operator[]</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#14ebc806ce3c4001230cef3a8686921b">operator[]</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#e4b4f208f1176a10af78a1a27760caa1">vtkArraySlice</a> (const <a class="el" href="a00135.html">vtkArrayRange</a> &i)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#e24c5487d9fd96f2765a62ce64706021">vtkArraySlice</a> (const <a class="el" href="a00135.html">vtkArrayRange</a> &i, const <a class="el" href="a00135.html">vtkArrayRange</a> &j)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#e8e62ff77cb5d6cd0f577aa33118b348">vtkArraySlice</a> (const <a class="el" href="a00135.html">vtkArrayRange</a> &i, const <a class="el" href="a00135.html">vtkArrayRange</a> &j, const <a class="el" href="a00135.html">vtkArrayRange</a> &k)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#3c3daebb190ec03981b72a2999f80013">operator<<</a> (ostream &stream, const <a class="el" href="a00136.html">vtkArraySlice</a> &rhs)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bb58a2e63b6803a57e2b69f1e25b97b6"></a><!-- doxytag: member="vtkArraySlice::vtkArraySlice" ref="bb58a2e63b6803a57e2b69f1e25b97b6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArraySlice::vtkArraySlice </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a zero-dimensional slice.
</div>
</div><p>
<a class="anchor" name="e4b4f208f1176a10af78a1a27760caa1"></a><!-- doxytag: member="vtkArraySlice::vtkArraySlice" ref="e4b4f208f1176a10af78a1a27760caa1" args="(const vtkArrayRange &i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArraySlice::vtkArraySlice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a one-dimensional slice.
</div>
</div><p>
<a class="anchor" name="e24c5487d9fd96f2765a62ce64706021"></a><!-- doxytag: member="vtkArraySlice::vtkArraySlice" ref="e24c5487d9fd96f2765a62ce64706021" args="(const vtkArrayRange &i, const vtkArrayRange &j)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArraySlice::vtkArraySlice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>j</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a two-dimensional slice.
</div>
</div><p>
<a class="anchor" name="e8e62ff77cb5d6cd0f577aa33118b348"></a><!-- doxytag: member="vtkArraySlice::vtkArraySlice" ref="e8e62ff77cb5d6cd0f577aa33118b348" args="(const vtkArrayRange &i, const vtkArrayRange &j, const vtkArrayRange &k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArraySlice::vtkArraySlice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00135.html">vtkArrayRange</a> & </td>
<td class="paramname"> <em>k</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a three-dimensional slice.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="19ee8ec8d2d0955cae41c63aa48ce68e"></a><!-- doxytag: member="vtkArraySlice::GetDimensions" ref="19ee8ec8d2d0955cae41c63aa48ce68e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> vtkArraySlice::GetDimensions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of dimensions in this slice.
</div>
</div><p>
<a class="anchor" name="7f0de4dbca27a8d10601a6b6fbd727a3"></a><!-- doxytag: member="vtkArraySlice::GetExtents" ref="7f0de4dbca27a8d10601a6b6fbd727a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00130.html">vtkArrayExtents</a> vtkArraySlice::GetExtents </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the extents of this slice - i.e: the size of the range along each dimension.
</div>
</div><p>
<a class="anchor" name="9fb01cbdf1cd8e016e4080c3eac08cf9"></a><!-- doxytag: member="vtkArraySlice::GetCoordinatesN" ref="9fb01cbdf1cd8e016e4080c3eac08cf9" args="(vtkIdType n) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00127.html">vtkArrayCoordinates</a> vtkArraySlice::GetCoordinatesN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns coordinates that reference the n-th value in the slice, where n is in the range [0, <a class="el" href="a00136.html#7f0de4dbca27a8d10601a6b6fbd727a3">GetExtents()</a>.GetSize()). Note that the order in which coordinates are visited is undefined.
</div>
</div><p>
<a class="anchor" name="1d186683d1919887f5993c218f30ff59"></a><!-- doxytag: member="vtkArraySlice::SetDimensions" ref="1d186683d1919887f5993c218f30ff59" args="(vtkIdType dimensions)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkArraySlice::SetDimensions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>dimensions</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the number of slice dimensions. Use operator[] to set the range along each dimension. Note that the range along each slice dimension will be empty after calling <a class="el" href="a00136.html#1d186683d1919887f5993c218f30ff59">SetDimensions()</a>, so you must explicitly set them all.
</div>
</div><p>
<a class="anchor" name="4e1a1d8fdddfb2fd11272f15d9a95a93"></a><!-- doxytag: member="vtkArraySlice::operator[]" ref="4e1a1d8fdddfb2fd11272f15d9a95a93" args="(vtkIdType i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00135.html">vtkArrayRange</a>& vtkArraySlice::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accesses the range of the i-th dimension.
</div>
</div><p>
<a class="anchor" name="14ebc806ce3c4001230cef3a8686921b"></a><!-- doxytag: member="vtkArraySlice::operator[]" ref="14ebc806ce3c4001230cef3a8686921b" args="(vtkIdType i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00135.html">vtkArrayRange</a>& vtkArraySlice::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accesses the rnage of the i-th dimension.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="3c3daebb190ec03981b72a2999f80013"></a><!-- doxytag: member="vtkArraySlice::operator<<" ref="3c3daebb190ec03981b72a2999f80013" args="(ostream &stream, const vtkArraySlice &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ostream& operator<< </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00136.html">vtkArraySlice</a> & </td>
<td class="paramname"> <em>rhs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03779.html">vtkArraySlice.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:53:34 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
139
