itkProgressReporter.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 itkProgressReporter_h
#define itkProgressReporter_h
 
#include "itkIntTypes.h"
#include "itkProcessObject.h"
 
namespace itk
{
class ITKCommon_EXPORT ProgressReporter
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ProgressReporter);
 
  ProgressReporter(ProcessObject * filter,
                   ThreadIdType    threadId,
                   SizeValueType   numberOfPixels,
                   SizeValueType   numberOfUpdates = 100,
                   float           initialProgress = 0.0f,
                   float           progressWeight = 1.0f);
 
  ~ProgressReporter();
 
  void
  CheckAbortGenerateData()
  {
    // all threads needs to check the abort flag
    if (m_Filter && m_Filter->GetAbortGenerateData())
    {
      std::string    msg;
      ProcessAborted e(__FILE__, __LINE__);
      msg += "Object " + std::string(m_Filter->GetNameOfClass()) + ": AbortGenerateDataOn";
      e.SetDescription(msg);
      throw e;
    }
  }
  void
  CompletedPixel()
  {
    // Inline implementation for efficiency.
    if (--m_PixelsBeforeUpdate == 0)
    {
      m_PixelsBeforeUpdate = m_PixelsPerUpdate;
      m_CurrentPixel += m_PixelsPerUpdate;
      // only thread 0 should update the progress of the filter
      if (m_ThreadId == 0 && m_Filter)
      {
        m_Filter->UpdateProgress(static_cast<float>(m_CurrentPixel) * m_InverseNumberOfPixels * m_ProgressWeight +
                                 m_InitialProgress);
      }
      this->CheckAbortGenerateData();
    }
  }
 
protected:
  ProcessObject * m_Filter;
  ThreadIdType    m_ThreadId;
  float           m_InverseNumberOfPixels;
  SizeValueType   m_CurrentPixel{ 0 };
  SizeValueType   m_PixelsPerUpdate;
  SizeValueType   m_PixelsBeforeUpdate;
  float           m_InitialProgress;
  float           m_ProgressWeight;
};
} // end namespace itk
 
#endif