Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itkProgressReporter.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkProgressReporter.h,v $
00005   Language:  C++
00006   Date:      $Date: 2003/09/10 14:29:23 $
00007   Version:   $Revision: 1.8 $
00008 
00009   Copyright (c) Insight Software Consortium. All rights reserved.
00010   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
00011 
00012      This software is distributed WITHOUT ANY WARRANTY; without even 
00013      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00014      PURPOSE.  See the above copyright notices for more information.
00015 
00016 =========================================================================*/
00017 #ifndef _itkProgressReporter_h
00018 #define _itkProgressReporter_h
00019 
00020 #include "itkProcessObject.h"
00021 
00022 namespace itk
00023 {
00024 
00058 class ITKCommon_EXPORT ProgressReporter
00059 {
00060 public:
00062   ProgressReporter(ProcessObject* filter, int threadId,
00063                    unsigned long numberOfPixels,
00064                    unsigned long numberOfUpdates = 100,
00065                    float initialProgress = 0.0f,
00066                    float progressWeight  = 1.0f );
00067   
00069   ~ProgressReporter();
00070   
00072   void CompletedPixel()
00073     {
00074     // Inline implementation for efficiency.
00075     // We don't need to test for thread id 0 here because the
00076     // constructor sets m_PixelsBeforeUpdate to a value larger than
00077     // the number of pixels for threads other than 0.
00078     if(--m_PixelsBeforeUpdate == 0)
00079       {
00080       m_PixelsBeforeUpdate = m_PixelsPerUpdate;
00081       m_CurrentPixel += m_PixelsPerUpdate;
00082       m_Filter->UpdateProgress(
00083           m_CurrentPixel * m_InverseNumberOfPixels * m_ProgressWeight + m_InitialProgress);
00084       if( m_Filter->GetAbortGenerateData() )
00085         {
00086         throw ProcessAborted();
00087         }
00088       }
00089     }
00090 
00091 protected:
00092   ProcessObject* m_Filter;
00093   int m_ThreadId;
00094   float m_InverseNumberOfPixels;
00095   unsigned long m_CurrentPixel;
00096   unsigned long m_PixelsPerUpdate;
00097   unsigned long m_PixelsBeforeUpdate;
00098   float  m_InitialProgress;
00099   float  m_ProgressWeight;
00100 
00101 private:
00102   ProgressReporter(); //purposely not implemented
00103 
00104 };
00105 
00106 } // end namespace itk
00107 
00108 #endif

Generated at Wed Mar 30 00:08:06 2005 for ITK by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2000