<!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: itkProgressReporter.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> <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="dir_02e23d841c198393a6e961e9a0678fff.html">Code</a> » <a class="el" href="dir_ea7fc529ede9a38b0438cf13831ae873.html">Common</a> </div> <div class="contents"> <h1>itkProgressReporter.h</h1><a href="itkProgressReporter_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 & Registration Toolkit</span> <a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: itkProgressReporter.h,v $</span> <a name="l00005"></a>00005 <span class="comment"> Language: C++</span> <a name="l00006"></a>00006 <span class="comment"> Date: $Date: 2006-07-24 11:41:15 $</span> <a name="l00007"></a>00007 <span class="comment"> Version: $Revision: 1.11 $</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 __itkProgressReporter_h</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __itkProgressReporter_h</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="itkProcessObject_8h.html">itkProcessObject.h</a>"</span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="keyword">namespace </span>itk <a name="l00023"></a>00023 { <a name="l00024"></a>00024 <a name="l00058"></a><a class="code" href="classitk_1_1ProgressReporter.html">00058</a> <span class="keyword">class </span><a class="code" href="itkWin32Header_8h.html#faefe352c9fb4179f5a770afc70ea90f">ITKCommon_EXPORT</a> <a class="code" href="classitk_1_1ProgressReporter.html" title="Implements progress tracking for a filter.">ProgressReporter</a> <a name="l00059"></a>00059 { <a name="l00060"></a>00060 <span class="keyword">public</span>: <a name="l00062"></a>00062 <a class="code" href="classitk_1_1ProgressReporter.html" title="Implements progress tracking for a filter.">ProgressReporter</a>(<a class="code" href="classitk_1_1ProcessObject.html" title="ProcessObject is the base class for all process objects (source, filters, mappers)...">ProcessObject</a>* filter, <span class="keywordtype">int</span> threadId, <a name="l00063"></a>00063 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> numberOfPixels, <a name="l00064"></a>00064 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> numberOfUpdates = 100, <a name="l00065"></a>00065 <span class="keywordtype">float</span> initialProgress = 0.0f, <a name="l00066"></a>00066 <span class="keywordtype">float</span> progressWeight = 1.0f ); <a name="l00067"></a>00067 <a name="l00069"></a>00069 ~<a class="code" href="classitk_1_1ProgressReporter.html" title="Implements progress tracking for a filter.">ProgressReporter</a>(); <a name="l00070"></a>00070 <a name="l00072"></a><a class="code" href="classitk_1_1ProgressReporter.html#c372ae52541f97c144563c57f092ae01">00072</a> <span class="keywordtype">void</span> CompletedPixel() <a name="l00073"></a>00073 { <a name="l00074"></a>00074 <span class="comment">// Inline implementation for efficiency.</span> <a name="l00075"></a>00075 <span class="keywordflow">if</span>(--m_PixelsBeforeUpdate == 0) <a name="l00076"></a>00076 { <a name="l00077"></a>00077 m_PixelsBeforeUpdate = m_PixelsPerUpdate; <a name="l00078"></a>00078 m_CurrentPixel += m_PixelsPerUpdate; <a name="l00079"></a>00079 <span class="comment">// only thread 0 should update the progress of the filter</span> <a name="l00080"></a>00080 <span class="keywordflow">if</span> (m_ThreadId == 0) <a name="l00081"></a>00081 { <a name="l00082"></a>00082 m_Filter->UpdateProgress( <a name="l00083"></a>00083 m_CurrentPixel * m_InverseNumberOfPixels * m_ProgressWeight + m_InitialProgress); <a name="l00084"></a>00084 } <a name="l00085"></a>00085 <span class="comment">// all threads needs to check the abort flag</span> <a name="l00086"></a>00086 <span class="keywordflow">if</span>( m_Filter->GetAbortGenerateData() ) <a name="l00087"></a>00087 { <a name="l00088"></a>00088 std::string msg; <a name="l00089"></a>00089 ProcessAborted e(__FILE__, __LINE__); <a name="l00090"></a>00090 msg += <span class="stringliteral">"Object "</span> + std::string(m_Filter->GetNameOfClass()) + <span class="stringliteral">": AbortGenerateDataOn"</span>; <a name="l00091"></a>00091 e.SetDescription(msg); <a name="l00092"></a>00092 <span class="keywordflow">throw</span> e; <a name="l00093"></a>00093 } <a name="l00094"></a>00094 } <a name="l00095"></a>00095 } <a name="l00097"></a>00097 <a name="l00098"></a>00098 <span class="keyword">protected</span>: <a name="l00099"></a><a class="code" href="classitk_1_1ProgressReporter.html#21f9ebd8a8c3ad0840fba81e5c32badf">00099</a> <a class="code" href="classitk_1_1ProcessObject.html" title="ProcessObject is the base class for all process objects (source, filters, mappers)...">ProcessObject</a>* m_Filter; <a name="l00100"></a><a class="code" href="classitk_1_1ProgressReporter.html#375a10cb88f878208cc11403baead335">00100</a> <span class="keywordtype">int</span> m_ThreadId; <a name="l00101"></a><a class="code" href="classitk_1_1ProgressReporter.html#1938472727456a9bb09ba09e55f66aea">00101</a> <span class="keywordtype">float</span> m_InverseNumberOfPixels; <a name="l00102"></a><a class="code" href="classitk_1_1ProgressReporter.html#6e1ce0c944f3279765fe320554cad2fa">00102</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_CurrentPixel; <a name="l00103"></a><a class="code" href="classitk_1_1ProgressReporter.html#b08c2073867bc91d7710c6839e5549e6">00103</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_PixelsPerUpdate; <a name="l00104"></a><a class="code" href="classitk_1_1ProgressReporter.html#a28f3aca3eae3815d872b7c4b95a8b57">00104</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_PixelsBeforeUpdate; <a name="l00105"></a><a class="code" href="classitk_1_1ProgressReporter.html#706ab3bb2a75f3d7bf3512cc7dc8e9c8">00105</a> <span class="keywordtype">float</span> m_InitialProgress; <a name="l00106"></a><a class="code" href="classitk_1_1ProgressReporter.html#e4b025f43fdf6b2a4f68205571e5a175">00106</a> <span class="keywordtype">float</span> m_ProgressWeight; <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="keyword">private</span>: <a name="l00109"></a>00109 <a class="code" href="classitk_1_1ProgressReporter.html" title="Implements progress tracking for a filter.">ProgressReporter</a>(); <span class="comment">//purposely not implemented</span> <a name="l00110"></a>00110 <a name="l00111"></a>00111 }; <a name="l00112"></a>00112 <a name="l00113"></a>00113 } <span class="comment">// end namespace itk</span> <a name="l00114"></a>00114 <a name="l00115"></a>00115 <span class="preprocessor">#endif</span> <a name="l00116"></a>00116 <span class="preprocessor"></span> </pre></div></div> <hr><address><small> Generated at Thu May 7 23:53:03 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>