Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > d5e74628f0e673bb8680aebce32b2c04 > files > 16344

itk-doc-3.12.0-1mdv2010.0.i586.rpm

<!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: itkLineConstIterator.h Source File</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>&nbsp;&nbsp; 
<a href="modules.html" class="qindex">Groups</a>&nbsp;&nbsp;
<a href="namespaces.html" class="qindex">Namespace List</a>&nbsp;&nbsp;
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>&nbsp;&nbsp;
<a href="classes.html" class="qindex">Alphabetical List</a>&nbsp;&nbsp;
<a href="annotated.html" class="qindex">Compound List</a>&nbsp;&nbsp; 
<a href="files.html" class="qindex">File
List</a>&nbsp;&nbsp; 
<a href="namespacemembers.html" class="qindex">Namespace Members</a>&nbsp;&nbsp; 
<a href="functions.html" class="qindex">Compound Members</a>&nbsp;&nbsp; 
<a href="globals.html" class="qindex">File Members</a>&nbsp;&nbsp;
<a href="pages.html" class="qindex">Concepts</a></center>


<!-- Generated by Doxygen 1.5.9 -->
  <div class="navpath"><a class="el" href="dir_02e23d841c198393a6e961e9a0678fff.html">Code</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_ea7fc529ede9a38b0438cf13831ae873.html">Common</a>
  </div>
<div class="contents">
<h1>itkLineConstIterator.h</h1><a href="itkLineConstIterator_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">  Program:   Insight Segmentation &amp; Registration Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: itkLineConstIterator.h,v $</span>
<a name="l00005"></a>00005 <span class="comment">  Language:  C++</span>
<a name="l00006"></a>00006 <span class="comment">  Date:      $Date: 2007-01-30 20:56:09 $</span>
<a name="l00007"></a>00007 <span class="comment">  Version:   $Revision: 1.5 $</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">  Copyright (c) Insight Software Consortium. All rights reserved.</span>
<a name="l00010"></a>00010 <span class="comment">  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment">     This software is distributed WITHOUT ANY WARRANTY; without even </span>
<a name="l00013"></a>00013 <span class="comment">     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR </span>
<a name="l00014"></a>00014 <span class="comment">     PURPOSE.  See the above copyright notices for more information.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">=========================================================================*/</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __itkLineConstIterator_h</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __itkLineConstIterator_h</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="itkIndex_8h.html">itkIndex.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="itkImage_8h.html">itkImage.h</a>"</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="keyword">namespace </span>itk
<a name="l00024"></a>00024 {
<a name="l00025"></a>00025 
<a name="l00049"></a>00049 <span class="keyword">template</span>&lt;<span class="keyword">class</span> TImage&gt;
<a name="l00050"></a><a class="code" href="classitk_1_1LineConstIterator.html">00050</a> <span class="keyword">class </span><a class="code" href="itkWin32Header_8h.html#7d4384322557205d75f0719c012dded6">ITK_EXPORT</a> <a class="code" href="classitk_1_1LineConstIterator.html" title="Iterator that walks a Bresenham line through an ND image.">LineConstIterator</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053 
<a name="l00055"></a><a class="code" href="classitk_1_1LineConstIterator.html#ebf45e25ba9ea34356a269e0ca5319ce">00055</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1LineConstIterator.html" title="Iterator that walks a Bresenham line through an ND image.">LineConstIterator</a> <a class="code" href="classitk_1_1LineConstIterator.html" title="Iterator that walks a Bresenham line through an ND image.">Self</a>;
<a name="l00056"></a>00056 
<a name="l00061"></a>00061   <a class="code" href="itkMacro_8h.html#1905cf6b2e88235996fa7ff73b2fb0eb">itkStaticConstMacro</a>(ImageIteratorDimension, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>,
<a name="l00062"></a>00062                       TImage::ImageDimension);
<a name="l00063"></a>00063 
<a name="l00065"></a><a class="code" href="classitk_1_1LineConstIterator.html#ae31ceb792ba79235a71410b72ce0d96">00065</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">TImage::IndexType</a>          <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a>;
<a name="l00066"></a><a class="code" href="classitk_1_1LineConstIterator.html#82383352f6204f75ff1a628c6a45e285">00066</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::IndexValueType     IndexValueType;
<a name="l00067"></a>00067 
<a name="l00069"></a><a class="code" href="classitk_1_1LineConstIterator.html#8fedf28fe1034c7f6dd302c229a2a2b1">00069</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::OffsetType         OffsetType;
<a name="l00070"></a><a class="code" href="classitk_1_1LineConstIterator.html#b6d4b74fd9300d0a3f599013d973b3f2">00070</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::OffsetValueType    OffsetValueType;
<a name="l00071"></a>00071 
<a name="l00073"></a><a class="code" href="classitk_1_1LineConstIterator.html#7203a1ba97eb7e45488ebe8891704c46">00073</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#5bf82236e1e50e653de84c8ead448599">TImage::SizeType</a>           <a class="code" href="namespaceHardConnectedComponentImageFilter.html#5bf82236e1e50e653de84c8ead448599">SizeType</a>;
<a name="l00074"></a><a class="code" href="classitk_1_1LineConstIterator.html#c265479c67a9f7be193de7d1512796af">00074</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::SizeValueType      SizeValueType;
<a name="l00075"></a>00075 
<a name="l00077"></a><a class="code" href="classitk_1_1LineConstIterator.html#fb0948af9f4b7b08df7c9201229e6eea">00077</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ed8c4a40607d317c666eb96ea265e126">TImage::RegionType</a>         <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ed8c4a40607d317c666eb96ea265e126">RegionType</a>;
<a name="l00078"></a>00078 
<a name="l00080"></a><a class="code" href="classitk_1_1LineConstIterator.html#3a60a34a62047ead2883cac2ba456410">00080</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::SpacingType        SpacingType;
<a name="l00081"></a>00081 
<a name="l00083"></a><a class="code" href="classitk_1_1LineConstIterator.html#99369768a108ed9d6bb15986e1c7891e">00083</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::PointType          PointType;
<a name="l00084"></a>00084 
<a name="l00086"></a><a class="code" href="classitk_1_1LineConstIterator.html#cfda5d8393fa5353356122925a505aaf">00086</a>   <span class="keyword">typedef</span> TImage                              ImageType;
<a name="l00087"></a>00087 
<a name="l00091"></a><a class="code" href="classitk_1_1LineConstIterator.html#a3c9dcae8cfdefcb02a9fabc508f715d">00091</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::PixelContainer     PixelContainer;
<a name="l00092"></a><a class="code" href="classitk_1_1LineConstIterator.html#b140a8ac7414ca36073119079011bfa7">00092</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="itkFEMMacro_8h.html#539cce1a3282ba59952dedcbf9cdb23f">PixelContainer::Pointer</a>    PixelContainerPointer;
<a name="l00093"></a>00093 
<a name="l00095"></a><a class="code" href="classitk_1_1LineConstIterator.html#a3ba6f5adc66f3d3e45feb22348bd296">00095</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::InternalPixelType  InternalPixelType;
<a name="l00096"></a>00096 
<a name="l00098"></a><a class="code" href="classitk_1_1LineConstIterator.html#ae18ee278b149db2e9152da09c6f2033">00098</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::PixelType          PixelType;
<a name="l00099"></a>00099 
<a name="l00102"></a><a class="code" href="classitk_1_1LineConstIterator.html#2b6d5f5da49f813cb0fae0a6905eaf82">00102</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> TImage::AccessorType       AccessorType;
<a name="l00103"></a>00103 
<a name="l00105"></a>00105   <a class="code" href="itkMacro_8h.html#574c1f86661d409dd32c742307a0e96a">itkTypeMacro</a>(<a class="code" href="classitk_1_1LineConstIterator.html" title="Iterator that walks a Bresenham line through an ND image.">LineConstIterator</a>, None);
<a name="l00106"></a>00106 
<a name="l00108"></a><a class="code" href="classitk_1_1LineConstIterator.html#d99cd535c47ecb49f974ea6fbf5eabea">00108</a>   <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetImageIteratorDimension() 
<a name="l00109"></a>00109     {
<a name="l00110"></a>00110     <span class="keywordflow">return</span> TImage::ImageDimension;
<a name="l00111"></a>00111     }
<a name="l00112"></a>00112 
<a name="l00114"></a><a class="code" href="classitk_1_1LineConstIterator.html#34a76ef41ffb9ac25e79d48cf12337f4">00114</a>   <span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> GetIndex()
<a name="l00115"></a>00115     {
<a name="l00116"></a>00116     <span class="keywordflow">return</span> m_CurrentImageIndex;
<a name="l00117"></a>00117     }
<a name="l00118"></a>00118 
<a name="l00120"></a><a class="code" href="classitk_1_1LineConstIterator.html#15a9f9ff0d6b032649fc5199078ce984">00120</a>   <span class="keyword">const</span> PixelType &amp; Get(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00121"></a>00121 <span class="keyword">    </span>{
<a name="l00122"></a>00122     <span class="keywordflow">return</span> m_Image-&gt;GetPixel(m_CurrentImageIndex );
<a name="l00123"></a>00123     }
<a name="l00124"></a>00124 
<a name="l00126"></a><a class="code" href="classitk_1_1LineConstIterator.html#35f1ef23ecc4a783c6fe4f63b3536b56">00126</a>   <span class="keywordtype">bool</span> IsAtEnd()
<a name="l00127"></a>00127     {
<a name="l00128"></a>00128     <span class="keywordflow">return</span> m_IsAtEnd;
<a name="l00129"></a>00129     }
<a name="l00130"></a>00130 
<a name="l00132"></a>00132   <span class="keywordtype">void</span> GoToBegin();
<a name="l00133"></a>00133 
<a name="l00135"></a>00135   <span class="keywordtype">void</span> operator++();
<a name="l00136"></a>00136 
<a name="l00139"></a>00139   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ac7d0120fe5292cdcdddb6163b8cb150">Self</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ac7d0120fe5292cdcdddb6163b8cb150">Self</a>&amp; it);
<a name="l00140"></a>00140 
<a name="l00142"></a>00142   <a class="code" href="classitk_1_1LineConstIterator.html" title="Iterator that walks a Bresenham line through an ND image.">LineConstIterator</a>(<span class="keyword">const</span> ImageType *imagePtr, <span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> &amp;firstIndex, <span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> &amp;lastIndex);
<a name="l00143"></a>00143 
<a name="l00145"></a><a class="code" href="classitk_1_1LineConstIterator.html#646b4f5b739123228a57eb7276041d68">00145</a>   <span class="keyword">virtual</span> <a class="code" href="classitk_1_1LineConstIterator.html#646b4f5b739123228a57eb7276041d68">~LineConstIterator</a>() {};
<a name="l00146"></a>00146 
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 <span class="keyword">protected</span>: <span class="comment">//made protected so other iterators can access </span>
<a name="l00150"></a>00150 <span class="comment"></span>  <span class="keyword">typename</span> ImageType::ConstWeakPointer m_Image;
<a name="l00151"></a>00151 
<a name="l00153"></a><a class="code" href="classitk_1_1LineConstIterator.html#764b55fd13eb7a4e9a2d485d3a636e09">00153</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ed8c4a40607d317c666eb96ea265e126">RegionType</a> m_Region;
<a name="l00154"></a>00154 
<a name="l00156"></a><a class="code" href="classitk_1_1LineConstIterator.html#12bd12ffad6a310904407ffa3531a732">00156</a>   <span class="keywordtype">bool</span> m_IsAtEnd;
<a name="l00157"></a>00157 
<a name="l00159"></a><a class="code" href="classitk_1_1LineConstIterator.html#46063fd081e146f6919ddc20ed3cdbc9">00159</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_CurrentImageIndex;
<a name="l00160"></a><a class="code" href="classitk_1_1LineConstIterator.html#79efeaa593caced5d3eb9694a9274d1a">00160</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_StartIndex;
<a name="l00161"></a><a class="code" href="classitk_1_1LineConstIterator.html#4d04ab3dd1c0dc0d74ec7d74478cf61c">00161</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_LastIndex;
<a name="l00162"></a><a class="code" href="classitk_1_1LineConstIterator.html#e85de4fb2422456fe32b2467b77f4d17">00162</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_EndIndex;  <span class="comment">// one past the end of the line in the m_MainDirection</span>
<a name="l00163"></a>00163 
<a name="l00165"></a>00165   <span class="comment">// The dimension with the largest difference between start and end</span>
<a name="l00166"></a><a class="code" href="classitk_1_1LineConstIterator.html#7bce93193aa4d380f1408bc6cca7ed92">00166</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_MainDirection; 
<a name="l00167"></a>00167 
<a name="l00168"></a>00168   <span class="comment">// Accumulated error for the other dimensions</span>
<a name="l00169"></a><a class="code" href="classitk_1_1LineConstIterator.html#fe25fef7f4fac6a57df07a755a0a3cf9">00169</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_AccumulateError;
<a name="l00170"></a>00170 
<a name="l00171"></a>00171   <span class="comment">// Increment for the error for each step. Two times the difference between</span>
<a name="l00172"></a>00172   <span class="comment">// start and end</span>
<a name="l00173"></a><a class="code" href="classitk_1_1LineConstIterator.html#ffcc4592e05d5a1ab78548a9b5f80d64">00173</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_IncrementError;
<a name="l00174"></a>00174 
<a name="l00175"></a>00175   <span class="comment">// If enough is accumulated for a dimension, the index has to be</span>
<a name="l00176"></a>00176   <span class="comment">// incremented. Will be the number of pixels in the line</span>
<a name="l00177"></a><a class="code" href="classitk_1_1LineConstIterator.html#a0c5fcdd316d8d76161bcb76806d8e13">00177</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_MaximalError; 
<a name="l00178"></a>00178 
<a name="l00179"></a>00179   <span class="comment">// Direction of increment. -1 or 1</span>
<a name="l00180"></a><a class="code" href="classitk_1_1LineConstIterator.html#fa595fa53cb053c2a83cf0c828c7b520">00180</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_OverflowIncrement; 
<a name="l00181"></a>00181 
<a name="l00182"></a>00182   <span class="comment">// After an overflow, the accumulated error is reduced again. Will be</span>
<a name="l00183"></a>00183   <span class="comment">// two times the number of pixels in the line</span>
<a name="l00184"></a><a class="code" href="classitk_1_1LineConstIterator.html#84e42fa48786733782f332a46faf2a98">00184</a>   <a class="code" href="namespaceHardConnectedComponentImageFilter.html#be32dc19e71d40322ad9828b9ab40853">IndexType</a> m_ReduceErrorAfterIncrement; 
<a name="l00185"></a>00185 };
<a name="l00186"></a>00186 
<a name="l00187"></a>00187 } <span class="comment">// end namespace itk</span>
<a name="l00188"></a>00188 
<a name="l00189"></a>00189 <span class="comment">// Define instantiation macro for this template.</span>
<a name="l00190"></a><a class="code" href="itkLineConstIterator_8h.html#99d1590008cb46244f99b197f14063a1">00190</a> <span class="preprocessor">#define ITK_TEMPLATE_LineConstIterator(_, EXPORT, x, y) namespace itk { \</span>
<a name="l00191"></a>00191 <span class="preprocessor">  _(1(class EXPORT LineConstIterator&lt; ITK_TEMPLATE_1 x &gt;)) \</span>
<a name="l00192"></a>00192 <span class="preprocessor">  namespace Templates { typedef LineConstIterator&lt; ITK_TEMPLATE_1 x &gt; \</span>
<a name="l00193"></a>00193 <span class="preprocessor">                                                  LineConstIterator##y; } \</span>
<a name="l00194"></a>00194 <span class="preprocessor">  }</span>
<a name="l00195"></a>00195 <span class="preprocessor"></span>
<a name="l00196"></a>00196 <span class="preprocessor">#if ITK_TEMPLATE_EXPLICIT</span>
<a name="l00197"></a>00197 <span class="preprocessor"></span><span class="preprocessor"># include "Templates/itkLineConstIterator+-.h"</span>
<a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
<a name="l00199"></a>00199 <span class="preprocessor"></span>
<a name="l00200"></a>00200 <span class="preprocessor">#if ITK_TEMPLATE_TXX</span>
<a name="l00201"></a>00201 <span class="preprocessor"></span><span class="preprocessor"># include "itkLineConstIterator.txx"</span>
<a name="l00202"></a>00202 <span class="preprocessor">#endif</span>
<a name="l00203"></a>00203 <span class="preprocessor"></span>
<a name="l00204"></a>00204 
<a name="l00205"></a>00205 <span class="preprocessor">#endif </span>
<a name="l00206"></a>00206 <span class="preprocessor"></span>
</pre></div></div>
<hr><address><small>
Generated at Thu May 7 23:25:43 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>,
 &copy;&nbsp;1997-2000</small></address>
</body>
</html>