<!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::Offset< VOffsetDimension > 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_1Offset.html">Offset</a>
</div>
<div class="contents">
<h1>itk::Offset< VOffsetDimension > Class Template Reference<br>
<small>
[<a class="el" href="group__ImageAccess.html">Image Access Objects</a>]</small>
</h1><!-- doxytag: class="itk::Offset" -->Represent the offset between two n-dimensional indexes in a n-dimensional image.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for itk::Offset< VOffsetDimension >:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1Offset__inherit__graph.png" border="0" usemap="#itk_1_1Offset_3_01VOffsetDimension_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1Offset_3_01VOffsetDimension_01_4__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1Offset.html" title="itk::Offset\< VDimension \>" alt="" coords="28,101,228,131"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classitk_1_1Offset-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 <br class="typebreak">
<a class="el" href="classitk_1_1Functor_1_1OffsetLexicographicCompare.html">Functor::OffsetLexicographicCompare</a><br class="typebreak">
< VOffsetDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#8b3c91be0202b8456c686f769b0b0df1">LexicographicCompare</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a>< VOffsetDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#b69eb70abe03832ed9caf58eeb4548d5">OffsetType</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_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#2eb3e7604abb0e2ae0b4087b9590dd04">Self</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_1Offset.html#faf9460568e7bb9cea0ff5186139ed64">Fill</a> (<a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#01c4c9a8d7fa35e6b510bbf1ea1bd7a3">GetOffset</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#baba461570cd2fce953d2fc61743c24d">operator[]</a> (unsigned int dim) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#dd84602cf03158c8f643ce86a0bd6bc0">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_1Offset.html#f3ff0babc64fec84105d5e31186396ea">SetOffset</a> (const <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> val[VOffsetDimension])</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_1Offset.html#e87b12164d465469a247b2f97c3ee1a3">operator!=</a> (const <a class="el" href="classitk_1_1Offset.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_1Offset.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#8cee38418e55db26c027f7ea0df27b59">operator+</a> (const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > &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_1Offset.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#aec22a8ca54e41b5e184ac4f71ca3aea">operator+</a> (const <a class="el" href="classitk_1_1Offset.html">Self</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_1Offset.html">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#ed51f32b9104195ab7ddf88ec062756c">operator+=</a> (const <a class="el" href="classitk_1_1Offset.html">Self</a> &vec)</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">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#f79e2d736e72a40a9e83a2ce8bef65db">operator+=</a> (const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > &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">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#324979129d55af379f13a3d8328d181b">operator-</a> (const <a class="el" href="classitk_1_1Offset.html">Self</a> &vec)</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">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#6d83f409670fcbe64ba8a5ff8dfd1b0e">operator-=</a> (const <a class="el" href="classitk_1_1Offset.html">Self</a> &vec)</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">Self</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#2cd265fc9c6df295cc1c37bc8bac46d7">operator-=</a> (const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > &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_1Offset.html#2e3763de495b9ec301eb5474216ddc18">operator==</a> (const <a class="el" href="classitk_1_1Offset.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_1Offset.html">Self</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#3bb746423b4f8c97751c3e4d8b60b743">GetBasisOffset</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_1Offset.html#7da0f3e281f8197b856246d9ecbdf4f2">GetOffsetDimension</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_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1Offset.html#9548e3c7c5d8791a909aa7f3af2df137">m_Offset</a> [VOffsetDimension]</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<unsigned int VOffsetDimension = 2><br>
class itk::Offset< VOffsetDimension ></h3>
Represent the offset between two n-dimensional indexes in a n-dimensional image.
<p>
<a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> is a templated class to represent a multi-dimensional offset, i.e. (i,j,k,...). <a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> is templated over the dimension of the space.<p>
For the sake of efficiency, <a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> does not define a default constructor, a copy constructor, or an operator=. We rely on the compiler to provide efficient bitwise copies.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Index.html" title="Represent a n-dimensional index in a n-dimensional image.">Index</a> </dd></dl>
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00059">59</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="8b3c91be0202b8456c686f769b0b0df1"></a><!-- doxytag: member="itk::Offset::LexicographicCompare" ref="8b3c91be0202b8456c686f769b0b0df1" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Functor_1_1OffsetLexicographicCompare.html">Functor::OffsetLexicographicCompare</a><VOffsetDimension> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::<a class="el" href="classitk_1_1Functor_1_1OffsetLexicographicCompare.html">LexicographicCompare</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lexicographic ordering functor type.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00072">72</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b69eb70abe03832ed9caf58eeb4548d5"></a><!-- doxytag: member="itk::Offset::OffsetType" ref="b69eb70abe03832ed9caf58eeb4548d5" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a><VOffsetDimension> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::<a class="el" href="classitk_1_1Offset.html">OffsetType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compatible offset typedefs.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00068">68</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a813bb2136a4584d5f3758447c3571bd"></a><!-- doxytag: member="itk::Offset::OffsetValueType" ref="a813bb2136a4584d5f3758447c3571bd" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef long <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::<a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00069">69</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2eb3e7604abb0e2ae0b4087b9590dd04"></a><!-- doxytag: member="itk::Offset::Self" ref="2eb3e7604abb0e2ae0b4087b9590dd04" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1Offset.html">Offset</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::<a class="el" href="classitk_1_1Offset.html">Self</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard class typedefs.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00062">62</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="faf9460568e7bb9cea0ff5186139ed64"></a><!-- doxytag: member="itk::Offset::Fill" ref="faf9460568e7bb9cea0ff5186139ed64" args="(OffsetValueType value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::Fill </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</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 offset in all dimensions. Useful for initializing an offset to zero.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00198">198</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3bb746423b4f8c97751c3e4d8b60b743"></a><!-- doxytag: member="itk::Offset::GetBasisOffset" ref="3bb746423b4f8c97751c3e4d8b60b743" args="(unsigned int dim)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Offset.html">Offset</a>< VOffsetDimension > <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::GetBasisOffset </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, ..., VOffsetDimension-1.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00254">254</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
<p>References <a class="el" href="itkOffset_8h_source.html#l00206">itk::Offset< VOffsetDimension >::m_Offset</a>.</p>
</div>
</div><p>
<a class="anchor" name="01c4c9a8d7fa35e6b510bbf1ea1bd7a3"></a><!-- doxytag: member="itk::Offset::GetOffset" ref="01c4c9a8d7fa35e6b510bbf1ea1bd7a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a>* <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::GetOffset </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_1Offset.html#f3ff0babc64fec84105d5e31186396ea">SetOffset()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00182">182</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7da0f3e281f8197b856246d9ecbdf4f2"></a><!-- doxytag: member="itk::Offset::GetOffsetDimension" ref="7da0f3e281f8197b856246d9ecbdf4f2" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">static unsigned int <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::GetOffsetDimension </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="itkOffset_8h_source.html#l00065">65</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e87b12164d465469a247b2f97c3ee1a3"></a><!-- doxytag: member="itk::Offset::operator!=" ref="e87b12164d465469a247b2f97c3ee1a3" args="(const Self &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.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 offsets.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00160">160</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8cee38418e55db26c027f7ea0df27b59"></a><!-- doxytag: member="itk::Offset::operator+" ref="8cee38418e55db26c027f7ea0df27b59" args="(const Size< VOffsetDimension > &size) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator+ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > & </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 offset.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00087">87</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="aec22a8ca54e41b5e184ac4f71ca3aea"></a><!-- doxytag: member="itk::Offset::operator+" ref="aec22a8ca54e41b5e184ac4f71ca3aea" args="(const Self &offset) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator+ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">Self</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 offset.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00076">76</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ed51f32b9104195ab7ddf88ec062756c"></a><!-- doxytag: member="itk::Offset::operator+=" ref="ed51f32b9104195ab7ddf88ec062756c" args="(const Self &vec)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a>& <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment offset by an offset.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00129">129</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f79e2d736e72a40a9e83a2ce8bef65db"></a><!-- doxytag: member="itk::Offset::operator+=" ref="f79e2d736e72a40a9e83a2ce8bef65db" args="(const Size< VOffsetDimension > &size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a>& <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > & </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.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00098">98</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="324979129d55af379f13a3d8328d181b"></a><!-- doxytag: member="itk::Offset::operator-" ref="324979129d55af379f13a3d8328d181b" args="(const Self &vec)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subtract two offsets.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00118">118</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6d83f409670fcbe64ba8a5ff8dfd1b0e"></a><!-- doxytag: member="itk::Offset::operator-=" ref="6d83f409670fcbe64ba8a5ff8dfd1b0e" args="(const Self &vec)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a>& <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator-= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html">Self</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrement offset by an offset.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00139">139</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2cd265fc9c6df295cc1c37bc8bac46d7"></a><!-- doxytag: member="itk::Offset::operator-=" ref="2cd265fc9c6df295cc1c37bc8bac46d7" args="(const Size< VOffsetDimension > &size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1Offset.html">Self</a>& <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator-= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Size.html">Size</a>< VOffsetDimension > & </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.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00108">108</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2e3763de495b9ec301eb5474216ddc18"></a><!-- doxytag: member="itk::Offset::operator==" ref="2e3763de495b9ec301eb5474216ddc18" args="(const Self &vec) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.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 offsets.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00149">149</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="baba461570cd2fce953d2fc61743c24d"></a><!-- doxytag: member="itk::Offset::operator[]" ref="baba461570cd2fce953d2fc61743c24d" args="(unsigned int dim) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::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, ..., VOffsetDimension-1. This version can only be an rvalue. No bounds checking is performed.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00177">177</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="dd84602cf03158c8f643ce86a0bd6bc0"></a><!-- doxytag: member="itk::Offset::operator[]" ref="dd84602cf03158c8f643ce86a0bd6bc0" args="(unsigned int dim)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a>& <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::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 offset. Elements are numbered 0, ..., VOffsetDimension-1. No bounds checking is performed.
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00171">171</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f3ff0babc64fec84105d5e31186396ea"></a><!-- doxytag: member="itk::Offset::SetOffset" ref="f3ff0babc64fec84105d5e31186396ea" args="(const OffsetValueType val[VOffsetDimension])" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::SetOffset </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> </td>
<td class="paramname"> <em>val</em>[VOffsetDimension] </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_1Offset.html#01c4c9a8d7fa35e6b510bbf1ea1bd7a3">GetOffset()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00188">188</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="9548e3c7c5d8791a909aa7f3af2df137"></a><!-- doxytag: member="itk::Offset::m_Offset" ref="9548e3c7c5d8791a909aa7f3af2df137" args="[VOffsetDimension]" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int VOffsetDimension = 2> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1Offset.html#a813bb2136a4584d5f3758447c3571bd">OffsetValueType</a> <a class="el" href="classitk_1_1Offset.html">itk::Offset</a>< VOffsetDimension >::<a class="el" href="classitk_1_1Offset.html#9548e3c7c5d8791a909aa7f3af2df137">m_Offset</a>[VOffsetDimension] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classitk_1_1Offset.html" title="Represent the offset between two n-dimensional indexes in a n-dimensional image.">Offset</a> is an "aggregate" class. Its data is public (m_Offset) allowing for fast and convenient instantiations/assignments.<p>
The following syntax for assigning an index is allowed/suggested: Offset<3> index = {5, 2, 7};
<p>Definition at line <a class="el" href="itkOffset_8h_source.html#l00206">206</a> of file <a class="el" href="itkOffset_8h_source.html">itkOffset.h</a>.</p>
<p>Referenced by <a class="el" href="itkOffset_8h_source.html#l00198">itk::Offset< VDimension >::Fill()</a>, <a class="el" href="itkOffset_8h_source.html#l00254">itk::Offset< VOffsetDimension >::GetBasisOffset()</a>, <a class="el" href="itkOffset_8h_source.html#l00182">itk::Offset< VDimension >::GetOffset()</a>, <a class="el" href="itkOffset_8h_source.html#l00160">itk::Offset< VDimension >::operator!=()</a>, <a class="el" href="itkOffset_8h_source.html#l00232">itk::Functor::OffsetLexicographicCompare< VOffsetDimension >::operator()()</a>, <a class="el" href="itkOffset_8h_source.html#l00076">itk::Offset< VDimension >::operator+()</a>, <a class="el" href="itkOffset_8h_source.html#l00098">itk::Offset< VDimension >::operator+=()</a>, <a class="el" href="itkOffset_8h_source.html#l00118">itk::Offset< VDimension >::operator-()</a>, <a class="el" href="itkIndex_8h_source.html#l00164">itk::Index< itkGetStaticConstMacro(Dimension)>::operator-()</a>, <a class="el" href="itkOffset_8h_source.html#l00108">itk::Offset< VDimension >::operator-=()</a>, <a class="el" href="itkOffset_8h_source.html#l00149">itk::Offset< VDimension >::operator==()</a>, <a class="el" href="itkOffset_8h_source.html#l00171">itk::Offset< VDimension >::operator[]()</a>, and <a class="el" href="itkOffset_8h_source.html#l00188">itk::Offset< VDimension >::SetOffset()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkOffset_8h_source.html">itkOffset.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 05:58:42 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
>
6727
