itkProgressAccumulator.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 itkProgressAccumulator_h
#define itkProgressAccumulator_h
 
#include "itkCommand.h"
#include "itkProcessObject.h"
#include <vector>
 
namespace itk
{
class ITKCommon_EXPORT ProgressAccumulator : public Object
{
public:
  using Self = ProgressAccumulator;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using GenericFilterType = ProcessObject;
  using GenericFilterPointer = GenericFilterType::Pointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ProgressAccumulator);

  itkGetConstMacro(AccumulatedProgress, float);

  itkSetObjectMacro(MiniPipelineFilter, ProcessObject);

  itkGetModifiableObjectMacro(MiniPipelineFilter, ProcessObject);

  void
  RegisterInternalFilter(GenericFilterType * filter, float weight);

  void
  UnregisterAllFilters();

#if !defined(ITK_LEGACY_REMOVE)
  void
  ResetProgress();
#endif

#if !defined(ITK_LEGACY_REMOVE)
  void
  ResetFilterProgressAndKeepAccumulatedProgress();
#endif
 
protected:
  ProgressAccumulator();
  ~ProgressAccumulator() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  using CommandType = MemberCommand<Self>;
  using CommandPointer = CommandType::Pointer;

  struct FilterRecord
  {
    // Pointer to the filter
    GenericFilterPointer Filter;
 
    // The weight of the filter in total progress of the mini-pipeline
    float Weight;
 
    // The tags for adding/removing observers to mini-pipeline filter
    unsigned long ProgressObserverTag;
    unsigned long StartObserverTag;
 
    float AccumulatedProgress{ 0.0 };
  };

  void
  ReportProgress(Object * who, const EventObject & event);

  GenericFilterPointer m_MiniPipelineFilter{};

  using FilterRecordVector = std::vector<struct FilterRecord>;

  float m_AccumulatedProgress{};

  float m_BaseAccumulatedProgress{};

  FilterRecordVector m_FilterRecord{};

  CommandPointer m_CallbackCommand{};
};
} // End namespace itk
 
#endif // itkProgressAccumulator_h_