itkIterationReporter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkIterationReporter.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:04:58 $
  Version:   $Revision: 1.5 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkIterationReporter_h
#define __itkIterationReporter_h

#include "itkProcessObject.h"

namespace itk
{

class ITKCommon_EXPORT IterationReporter
{
public:
  IterationReporter(ProcessObject* filter, int threadId,
                   unsigned long stepsPerUpdate = 100);

  ~IterationReporter() {};

  void CompletedStep()
    {
    // Inline implementation for efficiency.
    // We don't need to test for thread id 0 here because the
    // constructor sets m_StepsBeforeUpdate to a value larger than
    // the number of pixels for threads other than 0.
    if(--m_StepsBeforeUpdate == 0)
      {
      m_StepsBeforeUpdate = m_StepsPerUpdate;
      m_Filter->InvokeEvent( IterationEvent() );
      }
    }
protected:
  ProcessObject* m_Filter;
  int            m_ThreadId;
  unsigned long  m_StepsPerUpdate;
  unsigned long  m_StepsBeforeUpdate;
};

} // end namespace itk

#endif