<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ITK: itk::Index< VIndexDimension > Class Template Reference</title>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Section customized for INSIGHT : Tue Jul 17 01:02:45 2001 -->
<center>
<a href="index.html" class="qindex">Main Page</a>
<a href="modules.html" class="qindex">Groups</a>
<a href="namespaces.html" class="qindex">Namespace List</a>
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>
<a href="classes.html" class="qindex">Alphabetical List</a>
<a href="annotated.html" class="qindex">Compound List</a>
<a href="files.html" class="qindex">File
List</a>
<a href="namespacemembers.html" class="qindex">Namespace Members</a>
<a href="functions.html" class="qindex">Compound Members</a>
<a href="globals.html" class="qindex">File Members</a>
<a href="pages.html" class="qindex">Concepts</a></center>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="namespaceitk.html">itk</a>::<a class="el" href="classitk_1_1Index.html">Index</a>
</div>
<div class="contents">
<h1>itk::Index< VIndexDimension > Class Template Reference<br>
<small>
[<a class="el" href="group__ImageAccess.html">Image Access Objects</a>, <a class="el" href="group__ImageObjects.html">Image Representation Objects</a>]</small>
</h1><!-- doxytag: class="itk::Index" -->Represent a n-dimensional index in a n-dimensional image.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for itk::Index< VIndexDimension >:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1Index__inherit__graph.png" border="0" usemap="#itk_1_1Index_3_01VIndexDimension_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1Index_3_01VIndexDimension_01_4__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1Index.html" title="itk::Index\< VImageDimension \>" alt="" coords="619,7,853,36"><area shape="rect" id="node5" href="classitk_1_1Index.html" title="itk::Index\< VMeasurementVectorSize \>" alt="" coords="591,60,881,89"><area shape="rect" id="node7" href="classitk_1_1Index.html" title="itk::Index\< VDimension \>" alt="" coords="639,113,833,143"><area shape="rect" id="node9" href="classitk_1_1Index.html" title="itk::Index\< VSetDimension \>" alt="" coords="627,167,845,196"><area shape="rect" id="node11" href="classitk_1_1Index.html" title="itk::Index\< itkGetStaticConstMacro(Dimension)\>" alt="" coords="559,220,913,249"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classitk_1_1Index-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Index.html">Index</a>< VIndexDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#a2c3e158b744e622b34ffb2f2a5c65be">IndexType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef long </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <br class="typebreak">
<a class="el" href="classitk_1_1Functor_1_1IndexLexicographicCompare.html">Functor::IndexLexicographicCompare</a><br class="typebreak">
< VIndexDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#bc3119a987f475f53373ef0e12a5e72b">LexicographicCompare</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a>< VIndexDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#59a11dc4d23a2e11f0d08e1b4e566217">OffsetType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetType::OffsetValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#0a868216588d809d74536eb15b29aaa8">OffsetValueType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Index.html">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#fdba04c2e9e8d3d62c50d023a40af2e2">Self</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Size.html">Size</a>< VIndexDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#29c24184a0deaddadea1365866eaa17e">SizeType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#699b209e56b2a7b5005cd1b3530cce5a">Fill</a> (<a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#a36ee33439ff89f5dc73699fcc780df0">GetElement</a> (unsigned long element)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#45a7db4a89e48d5879a845f332f53371">GetIndex</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#2df5cf34ec570cebce7e6cc406c65e28">operator[]</a> (unsigned int dim) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#80b7b47bedfa91e731ac6e72154e3f66">operator[]</a> (unsigned int dim)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#fbca286e2c7170eda1117cf7f95a6103">SetElement</a> (unsigned long element, <a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#74e9e293dc8d4a7fb886f9b32e7e381c">SetIndex</a> (const <a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> val[VIndexDimension])</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class TCoordRep > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#91085870082565be3991311539b0acd1">CopyWithCast</a> (const <a class="el" href="classitk_1_1FixedArray.html">FixedArray</a>< TCoordRep, VIndexDimension > &point)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class TCoordRep > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#cce704fbc53e0757fd4bcf3fdf01d7c8">CopyWithRound</a> (const <a class="el" href="classitk_1_1FixedArray.html">FixedArray</a>< TCoordRep, VIndexDimension > &point)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#7db90a22013ca76472bbb77bda9eec0f">operator!=</a> (const <a class="el" href="classitk_1_1Index.html">Self</a> &vec) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#75d69c8755841d221c25c623e36eecb6">operator*</a> (const <a class="el" href="classitk_1_1Size.html">SizeType</a> &vec) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#af8ac7bb68d5768c9d2f378adede0f1d">operator+</a> (const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> &offset) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#7cdbfeeb68f5442acd0641cba19e488c">operator+</a> (const <a class="el" href="classitk_1_1Size.html">SizeType</a> &size) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#6edb38e2e82eed03a6ee22877d4a22bf">operator+=</a> (const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> &offset)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#ebb219b780bf52aa0aa68315afc67b96">operator+=</a> (const <a class="el" href="classitk_1_1Size.html">SizeType</a> &size)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#c7d8b575ff85ef654b6d97b6301be41a">operator-</a> (const <a class="el" href="classitk_1_1Index.html">Self</a> &vec) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#cae0154c7abd67af2849657943eec1b8">operator-</a> (const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> &off) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#df8c1fb96b870a435181b32588258996">operator-</a> (const <a class="el" href="classitk_1_1Size.html">SizeType</a> &size) const </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#03dd2c9b5e0e978e3ff1b7d74e291f5d">operator-=</a> (const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> &offset)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#9eea7b7497425017176234e80a070cb1">operator-=</a> (const <a class="el" href="classitk_1_1Size.html">SizeType</a> &size)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#54e949c3945bb1dd58272c1d4d455244">operator==</a> (const <a class="el" href="classitk_1_1Index.html">Self</a> &vec) const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classitk_1_1Index.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#efc6e1302bc6250d33e864b10cf1bdbe">GetBasisIndex</a> (unsigned int dim)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#587b0ccd9ad71e3bf1c8b07e7d9f85d0">GetIndexDimension</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Index.html#f3d5b61b4f6bd1ac55a54562e58d7047">m_Index</a> [VIndexDimension]</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<unsigned int VIndexDimension = 2><br>
class itk::Index< VIndexDimension ></h3>
Represent a n-dimensional index in a n-dimensional image.
<p>
<a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> is a templated class to represent a multi-dimensional index, i.e. (i,j,k,...). <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> is templated over the dimension of the index. ITK assumes the first element of an index is the fastest moving index.<p>
For efficiency sake, <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> does not define a default constructor, a copy constructor, or an operator=. We rely on the compiler to provide efficient bitwise copies.<p>
<a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> is an "aggregate" class. Its data is public (m_Index) allowing for fast and convenient instantiations/assignments.<p>
The following syntax for assigning an index is allowed/suggested:<p>
Index<3> index = {{5, 2, 7}};<p>
The double braces {{ and }} are needed to prevent a compiler warning about a partly bracketed initializer.<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Should there be an itkBoundedIndex to handle bounds checking? Or should there be an API to perform bounded increments in the iterator. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="Common_2itkImageSliceIteratorTest_8cxx-example.html#_a0">Common/itkImageSliceIteratorTest.cxx</a>.</dl>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00067">67</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="a2c3e158b744e622b34ffb2f2a5c65be"></a><!-- doxytag: member="itk::Index::IndexType" ref="a2c3e158b744e622b34ffb2f2a5c65be" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Index.html">Index</a><VIndexDimension> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Index.html">IndexType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compatible <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> and value typedef
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00073">73</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bcd2aba05e60b776c5e75f72ed86420b"></a><!-- doxytag: member="itk::Index::IndexValueType" ref="bcd2aba05e60b776c5e75f72ed86420b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef long <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00074">74</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bc3119a987f475f53373ef0e12a5e72b"></a><!-- doxytag: member="itk::Index::LexicographicCompare" ref="bc3119a987f475f53373ef0e12a5e72b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Functor_1_1IndexLexicographicCompare.html">Functor::IndexLexicographicCompare</a><VIndexDimension> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Functor_1_1IndexLexicographicCompare.html">LexicographicCompare</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lexicographic ordering functor type.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00087">87</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="59a11dc4d23a2e11f0d08e1b4e566217"></a><!-- doxytag: member="itk::Index::OffsetType" ref="59a11dc4d23a2e11f0d08e1b4e566217" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a><VIndexDimension> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Offset.html">OffsetType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compatible <a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> and <a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> value typedef.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00083">83</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0a868216588d809d74536eb15b29aaa8"></a><!-- doxytag: member="itk::Index::OffsetValueType" ref="0a868216588d809d74536eb15b29aaa8" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetType::OffsetValueType</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Index.html#0a868216588d809d74536eb15b29aaa8">OffsetValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00084">84</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="fdba04c2e9e8d3d62c50d023a40af2e2"></a><!-- doxytag: member="itk::Index::Self" ref="fdba04c2e9e8d3d62c50d023a40af2e2" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Index.html">Index</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Index.html">Self</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard class typedefs.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00070">70</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="29c24184a0deaddadea1365866eaa17e"></a><!-- doxytag: member="itk::Index::SizeType" ref="29c24184a0deaddadea1365866eaa17e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Size.html">Size</a><VIndexDimension> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Size.html">SizeType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compatible <a class="el" href="classitk_1_1Size.html" title="Represent the size (bounds) of a n-dimensional image.">Size</a> typedef.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00080">80</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="91085870082565be3991311539b0acd1"></a><!-- doxytag: member="itk::Index::CopyWithCast" ref="91085870082565be3991311539b0acd1" args="(const FixedArray< TCoordRep, VIndexDimension > &point)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<div class="memtemplate">
template<class TCoordRep > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::CopyWithCast </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1FixedArray.html">FixedArray</a>< TCoordRep, VIndexDimension > & </td>
<td class="paramname"> <em>point</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy values from a <a class="el" href="classitk_1_1FixedArray.html" title="Simulate a standard C array with copy semnatics.">FixedArray</a> by casting each one of the components
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00307">307</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="cce704fbc53e0757fd4bcf3fdf01d7c8"></a><!-- doxytag: member="itk::Index::CopyWithRound" ref="cce704fbc53e0757fd4bcf3fdf01d7c8" args="(const FixedArray< TCoordRep, VIndexDimension > &point)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<div class="memtemplate">
template<class TCoordRep > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::CopyWithRound </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1FixedArray.html">FixedArray</a>< TCoordRep, VIndexDimension > & </td>
<td class="paramname"> <em>point</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy values from a <a class="el" href="classitk_1_1FixedArray.html" title="Simulate a standard C array with copy semnatics.">FixedArray</a> by rounding each one of the components
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00289">289</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="699b209e56b2a7b5005cd1b3530cce5a"></a><!-- doxytag: member="itk::Index::Fill" ref="699b209e56b2a7b5005cd1b3530cce5a" args="(IndexValueType value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::Fill </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set one value for the index in all dimensions. Useful for initializing an offset to zero.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00265">265</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
<p>Referenced by <a class="el" href="itkImageIORegion_8h_source.html#l00212">itk::ImageIORegionAdaptor< VDimension >::Convert()</a>.</p>
</div>
</div><p>
<a class="anchor" name="efc6e1302bc6250d33e864b10cf1bdbe"></a><!-- doxytag: member="itk::Index::GetBasisIndex" ref="efc6e1302bc6250d33e864b10cf1bdbe" args="(unsigned int dim)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Index.html">Index</a>< VIndexDimension > <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::GetBasisIndex </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>dim</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a basis vector of the form [0, ..., 0, 1, 0, ... 0] where the "1" is positioned in the location specified by the parameter "dim". Valid values of "dim" are 0, ..., VIndexDimension-1.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00360">360</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
<p>References <a class="el" href="itkIndex_8h_source.html#l00273">itk::Index< VIndexDimension >::m_Index</a>.</p>
</div>
</div><p>
<a class="anchor" name="a36ee33439ff89f5dc73699fcc780df0"></a><!-- doxytag: member="itk::Index::GetElement" ref="a36ee33439ff89f5dc73699fcc780df0" args="(unsigned long element)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::GetElement </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>element</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the value of one of the elements in the index. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient. <dl class="warning" compact><dt><b>Warning:</b></dt><dd>No bound checking is performed </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Index.html#45a7db4a89e48d5879a845f332f53371">GetIndex()</a> <p>
<a class="el" href="classitk_1_1Index.html#fbca286e2c7170eda1117cf7f95a6103">SetElement()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00255">255</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="45a7db4a89e48d5879a845f332f53371"></a><!-- doxytag: member="itk::Index::GetIndex" ref="45a7db4a89e48d5879a845f332f53371" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a>* <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::GetIndex </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the index. This provides a read only reference to the index. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Index.html#74e9e293dc8d4a7fb886f9b32e7e381c">SetIndex()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00231">231</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="587b0ccd9ad71e3bf1c8b07e7d9f85d0"></a><!-- doxytag: member="itk::Index::GetIndexDimension" ref="587b0ccd9ad71e3bf1c8b07e7d9f85d0" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">static unsigned int <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::GetIndexDimension </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the dimension (size) of the index.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00077">77</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7db90a22013ca76472bbb77bda9eec0f"></a><!-- doxytag: member="itk::Index::operator!=" ref="7db90a22013ca76472bbb77bda9eec0f" args="(const Self &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two indices.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00209">209</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="75d69c8755841d221c25c623e36eecb6"></a><!-- doxytag: member="itk::Index::operator*" ref="75d69c8755841d221c25c623e36eecb6" args="(const SizeType &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator* </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">SizeType</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Multiply an index by a size (elementwise product). This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00187">187</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="af8ac7bb68d5768c9d2f378adede0f1d"></a><!-- doxytag: member="itk::Index::operator+" ref="af8ac7bb68d5768c9d2f378adede0f1d" args="(const OffsetType &offset) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator+ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> & </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an offset to an index.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00133">133</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7cdbfeeb68f5442acd0641cba19e488c"></a><!-- doxytag: member="itk::Index::operator+" ref="7cdbfeeb68f5442acd0641cba19e488c" args="(const SizeType &size) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator+ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">SizeType</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a size to an index. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00091">91</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6edb38e2e82eed03a6ee22877d4a22bf"></a><!-- doxytag: member="itk::Index::operator+=" ref="6edb38e2e82eed03a6ee22877d4a22bf" args="(const OffsetType &offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a>& <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> & </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment index by an offset. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00144">144</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ebb219b780bf52aa0aa68315afc67b96"></a><!-- doxytag: member="itk::Index::operator+=" ref="ebb219b780bf52aa0aa68315afc67b96" args="(const SizeType &size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a>& <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">SizeType</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment index by a size. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00102">102</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c7d8b575ff85ef654b6d97b6301be41a"></a><!-- doxytag: member="itk::Index::operator-" ref="c7d8b575ff85ef654b6d97b6301be41a" args="(const Self &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subtract two indices. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00175">175</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="cae0154c7abd67af2849657943eec1b8"></a><!-- doxytag: member="itk::Index::operator-" ref="cae0154c7abd67af2849657943eec1b8" args="(const OffsetType &off) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> & </td>
<td class="paramname"> <em>off</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subtract an offset from an index.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00164">164</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="df8c1fb96b870a435181b32588258996"></a><!-- doxytag: member="itk::Index::operator-" ref="df8c1fb96b870a435181b32588258996" args="(const SizeType &size) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">SizeType</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subtract a size from an index. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00112">112</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="03dd2c9b5e0e978e3ff1b7d74e291f5d"></a><!-- doxytag: member="itk::Index::operator-=" ref="03dd2c9b5e0e978e3ff1b7d74e291f5d" args="(const OffsetType &offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a>& <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator-= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">OffsetType</a> & </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrement index by an offset. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00154">154</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9eea7b7497425017176234e80a070cb1"></a><!-- doxytag: member="itk::Index::operator-=" ref="9eea7b7497425017176234e80a070cb1" args="(const SizeType &size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Index.html">Self</a>& <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator-= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">SizeType</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrement index by a size. This method models a random access <a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a>.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00123">123</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="54e949c3945bb1dd58272c1d4d455244"></a><!-- doxytag: member="itk::Index::operator==" ref="54e949c3945bb1dd58272c1d4d455244" args="(const Self &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Index.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two indices.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00198">198</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2df5cf34ec570cebce7e6cc406c65e28"></a><!-- doxytag: member="itk::Index::operator[]" ref="2df5cf34ec570cebce7e6cc406c65e28" args="(unsigned int dim) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>dim</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Access an element of the index. Elements are numbered 0, ..., VIndexDimension-1. This version can only be an rvalue. No bounds checking is performed.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00226">226</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="80b7b47bedfa91e731ac6e72154e3f66"></a><!-- doxytag: member="itk::Index::operator[]" ref="80b7b47bedfa91e731ac6e72154e3f66" args="(unsigned int dim)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a>& <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>dim</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Access an element of the index. Elements are numbered 0, ..., VIndexDimension-1. No bounds checking is performed.
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00220">220</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="fbca286e2c7170eda1117cf7f95a6103"></a><!-- doxytag: member="itk::Index::SetElement" ref="fbca286e2c7170eda1117cf7f95a6103" args="(unsigned long element, IndexValueType val)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::SetElement </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>element</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the value of one of the elements in the index. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient. <dl class="warning" compact><dt><b>Warning:</b></dt><dd>No bound checking is performed </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Index.html#74e9e293dc8d4a7fb886f9b32e7e381c">SetIndex()</a> <p>
<a class="el" href="classitk_1_1Index.html#a36ee33439ff89f5dc73699fcc780df0">GetElement()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00246">246</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="74e9e293dc8d4a7fb886f9b32e7e381c"></a><!-- doxytag: member="itk::Index::SetIndex" ref="74e9e293dc8d4a7fb886f9b32e7e381c" args="(const IndexValueType val[VIndexDimension])" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::SetIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> </td>
<td class="paramname"> <em>val</em>[VIndexDimension] </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the index. Try to prototype this function so that val has to point to a block of memory that is the appropriate size. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Index.html#45a7db4a89e48d5879a845f332f53371">GetIndex()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00237">237</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f3d5b61b4f6bd1ac55a54562e58d7047"></a><!-- doxytag: member="itk::Index::m_Index" ref="f3d5b61b4f6bd1ac55a54562e58d7047" args="[VIndexDimension]" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VIndexDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Index.html#bcd2aba05e60b776c5e75f72ed86420b">IndexValueType</a> <a class="el" href="classitk_1_1Index.html">itk::Index</a>< VIndexDimension >::<a class="el" href="classitk_1_1Index.html#f3d5b61b4f6bd1ac55a54562e58d7047">m_Index</a>[VIndexDimension] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> is an "aggregate" class. Its data is public (m_Index) allowing for fast and convenient instantiations/assignments.<p>
The following syntax for assigning an index is allowed/suggested: Index<3> index = {5, 2, 7};
<p>Definition at line <a class="el" href="itkIndex_8h_source.html#l00273">273</a> of file <a class="el" href="itkIndex_8h_source.html">itkIndex.h</a>.</p>
<p>Referenced by <a class="el" href="itkIndex_8h_source.html#l00307">itk::Index< itkGetStaticConstMacro(Dimension)>::CopyWithCast()</a>, <a class="el" href="itkIndex_8h_source.html#l00289">itk::Index< itkGetStaticConstMacro(Dimension)>::CopyWithRound()</a>, <a class="el" href="itkIndex_8h_source.html#l00265">itk::Index< itkGetStaticConstMacro(Dimension)>::Fill()</a>, <a class="el" href="itkIndex_8h_source.html#l00360">itk::Index< VIndexDimension >::GetBasisIndex()</a>, <a class="el" href="itkIndex_8h_source.html#l00255">itk::Index< itkGetStaticConstMacro(Dimension)>::GetElement()</a>, <a class="el" href="itkIndex_8h_source.html#l00231">itk::Index< itkGetStaticConstMacro(Dimension)>::GetIndex()</a>, <a class="el" href="itkIndex_8h_source.html#l00209">itk::Index< itkGetStaticConstMacro(Dimension)>::operator!=()</a>, <a class="el" href="itkIndex_8h_source.html#l00338">itk::Functor::IndexLexicographicCompare< VIndexDimension >::operator()()</a>, <a class="el" href="itkIndex_8h_source.html#l00187">itk::Index< itkGetStaticConstMacro(Dimension)>::operator*()</a>, <a class="el" href="itkIndex_8h_source.html#l00091">itk::Index< itkGetStaticConstMacro(Dimension)>::operator+()</a>, <a class="el" href="itkIndex_8h_source.html#l00102">itk::Index< itkGetStaticConstMacro(Dimension)>::operator+=()</a>, <a class="el" href="itkIndex_8h_source.html#l00112">itk::Index< itkGetStaticConstMacro(Dimension)>::operator-()</a>, <a class="el" href="itkIndex_8h_source.html#l00123">itk::Index< itkGetStaticConstMacro(Dimension)>::operator-=()</a>, <a class="el" href="itkIndex_8h_source.html#l00198">itk::Index< itkGetStaticConstMacro(Dimension)>::operator==()</a>, <a class="el" href="itkIndex_8h_source.html#l00220">itk::Index< itkGetStaticConstMacro(Dimension)>::operator[]()</a>, <a class="el" href="itkIndex_8h_source.html#l00246">itk::Index< itkGetStaticConstMacro(Dimension)>::SetElement()</a>, and <a class="el" href="itkIndex_8h_source.html#l00237">itk::Index< itkGetStaticConstMacro(Dimension)>::SetIndex()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkIndex_8h_source.html">itkIndex.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 04:27:16 2009 for ITK by <a href="http://www.stack.nl/~dimitri/doxygen/index.html"> <img
src="http://www.stack.nl/~dimitri/doxygen/doxygen.png" alt="doxygen"
align="middle" border=0 width=110 height=53>
</a> 1.5.9 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2000</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d5e74628f0e673bb8680aebce32b2c04
>
files
>
4556
