itkIterationReporter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkIterationReporter_h
#define itkIterationReporter_h
 
#include "itkProcessObject.h"
 
namespace itk
{
class ITKCommon_EXPORT IterationReporter
{
public:
  IterationReporter(ProcessObject * filter, ThreadIdType threadId, unsigned long stepsPerUpdate = 100);

  ~IterationReporter() = default;

  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;
  ThreadIdType    m_ThreadId;
  unsigned long   m_StepsPerUpdate;
  unsigned long   m_StepsBeforeUpdate;
};
} // end namespace itk
 
#endif