<!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::SliceIterator< TPixel, TContainer > 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_1SliceIterator.html">SliceIterator</a> </div> <div class="contents"> <h1>itk::SliceIterator< TPixel, TContainer > Class Template Reference<br> <small> [<a class="el" href="group__Iterators.html">Iterators</a>]</small> </h1><!-- doxytag: class="itk::SliceIterator" --><a class="el" href="classA.html">A</a> flexible iterator for <a class="el" href="namespaceitk.html" title="Hashtable class, used to implement the hashed associative containers itk_hash_set...">itk</a> containers(i.e. <a class="el" href="classitk_1_1Neighborhood.html" title="A light-weight container object for storing an N-dimensional neighborhood of values...">itk::Neighborhood</a>) that support pixel access through operator[]. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>></code> <p> <p> <a href="classitk_1_1SliceIterator-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 Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#6b17ff95c79960cefaa87165d6086e20">Begin</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#58baee3c75e6288b1f4b94fbc41ee4f9">operator!=</a> (const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> &orig)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">TPixel & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#da0b60f511197edad461c1a50a6e2266">operator*</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#a1e410bdd40a81f8f7e45e17f2df10c5">operator++</a> (int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#eece68474bf55c467774cd696102dfdf">operator++</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#a63896c0b4553a83ba8259fcb0896546">operator<</a> (const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> &orig)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#ea0c2db107ad73e12be4b377e5daf878">operator==</a> (const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> &orig)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">TPixel & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#70b425d8d3e77a4f4e5e602aebf9db03">operator[]</a> (unsigned long n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#ba9b3620a45669a56efd0cc4c4716c35">SliceIterator</a> (TContainer *n, std::slice s)</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SliceIterator.html#5bffa37bf712d7577143f6511d5f9cfb">End</a> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class TPixel, class TContainer><br> class itk::SliceIterator< TPixel, TContainer ></h3> <a class="el" href="classA.html">A</a> flexible iterator for <a class="el" href="namespaceitk.html" title="Hashtable class, used to implement the hashed associative containers itk_hash_set...">itk</a> containers(i.e. <a class="el" href="classitk_1_1Neighborhood.html" title="A light-weight container object for storing an N-dimensional neighborhood of values...">itk::Neighborhood</a>) that support pixel access through operator[]. <p> <a class="el" href="classitk_1_1SliceIterator.html" title="A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel...">SliceIterator</a> allows iteration along a std::slice through the container. <a class="el" href="classA.html">A</a> slice is a construct that defines a starting position, stride length (distance between adjacent elements), and a length.<p> Any container with operator[] is supported. Because it uses this interface the iterator is only as efficient as the implementation of a container's operator[] method.<p> References: Modeled after a slice iterator proposed by Bjarne Stroustrup in C++ Programming Language, Third Edition. Bjarne Stroustrup. Addison Wesley, Reading, MA. 1997. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00045">45</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="ba9b3620a45669a56efd0cc4c4716c35"></a><!-- doxytag: member="itk::SliceIterator::SliceIterator" ref="ba9b3620a45669a56efd0cc4c4716c35" args="(TContainer *n, std::slice s)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::<a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> </td> <td>(</td> <td class="paramtype">TContainer * </td> <td class="paramname"> <em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::slice </td> <td class="paramname"> <em>s</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> Constructor. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00049">49</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="6b17ff95c79960cefaa87165d6086e20"></a><!-- doxytag: member="itk::SliceIterator::Begin" ref="6b17ff95c79960cefaa87165d6086e20" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::Begin </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a <a class="el" href="classitk_1_1SliceIterator.html" title="A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel...">SliceIterator</a> that points to the beginning of the slice. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00053">53</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="5bffa37bf712d7577143f6511d5f9cfb"></a><!-- doxytag: member="itk::SliceIterator::End" ref="5bffa37bf712d7577143f6511d5f9cfb" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::End </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a <a class="el" href="classitk_1_1SliceIterator.html" title="A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel...">SliceIterator</a> that points to one past the end of the slice. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00061">61</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="58baee3c75e6288b1f4b94fbc41ee4f9"></a><!-- doxytag: member="itk::SliceIterator::operator!=" ref="58baee3c75e6288b1f4b94fbc41ee4f9" args="(const SliceIterator &orig)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator!= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a>< TPixel, TContainer > & </td> <td class="paramname"> <em>orig</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the logical inverse of the boolean == of two slice iterators. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00104">104</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> <p>References <a class="el" href="itk__hash__map_8h_source.html#l00332">itk::operator==()</a>.</p> </div> </div><p> <a class="anchor" name="da0b60f511197edad461c1a50a6e2266"></a><!-- doxytag: member="itk::SliceIterator::operator*" ref="da0b60f511197edad461c1a50a6e2266" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname">TPixel& <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator* </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Dereferences the iterator, returning the value that it points to. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00091">91</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="a1e410bdd40a81f8f7e45e17f2df10c5"></a><!-- doxytag: member="itk::SliceIterator::operator++" ref="a1e410bdd40a81f8f7e45e17f2df10c5" args="(int)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator++ </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Increments the iterator. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00077">77</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="eece68474bf55c467774cd696102dfdf"></a><!-- doxytag: member="itk::SliceIterator::operator++" ref="eece68474bf55c467774cd696102dfdf" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a> <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator++ </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Increments the iterator. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00070">70</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="a63896c0b4553a83ba8259fcb0896546"></a><!-- doxytag: member="itk::SliceIterator::operator<" ref="a63896c0b4553a83ba8259fcb0896546" args="(const SliceIterator &orig)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator< </td> <td>(</td> <td class="paramtype">const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a>< TPixel, TContainer > & </td> <td class="paramname"> <em>orig</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the boolean < of two slice iterator positions. Result is only true if the slice iterators have the same stride and start location. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00112">112</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="ea0c2db107ad73e12be4b377e5daf878"></a><!-- doxytag: member="itk::SliceIterator::operator==" ref="ea0c2db107ad73e12be4b377e5daf878" args="(const SliceIterator &orig)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classitk_1_1SliceIterator.html">SliceIterator</a>< TPixel, TContainer > & </td> <td class="paramname"> <em>orig</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the logical && of the boolean == of two slice iterator positions, stride, and start locations. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00096">96</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <a class="anchor" name="70b425d8d3e77a4f4e5e602aebf9db03"></a><!-- doxytag: member="itk::SliceIterator::operator[]" ref="70b425d8d3e77a4f4e5e602aebf9db03" args="(unsigned long n)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class TPixel , class TContainer > </div> <table class="memname"> <tr> <td class="memname">TPixel& <a class="el" href="classitk_1_1SliceIterator.html">itk::SliceIterator</a>< TPixel, TContainer >::operator[] </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>n</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the element at position n of the slice. Sets the iterator to point to position n. <p>Definition at line <a class="el" href="itkSliceIterator_8h_source.html#l00086">86</a> of file <a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="itkSliceIterator_8h_source.html">itkSliceIterator.h</a></ul> </div> <hr><address><small> Generated at Fri May 8 07:04:50 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>