itkProgressAccumulator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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:

  typedef ProgressAccumulator        Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef ProcessObject              GenericFilterType;
  typedef GenericFilterType::Pointer GenericFilterPointer;

  itkNewMacro(Self);

  itkTypeMacro(ProgressAccumulator, Object);

  itkGetConstMacro(AccumulatedProgress, float);

  itkSetObjectMacro(MiniPipelineFilter, ProcessObject);

  itkGetModifiableObjectMacro(MiniPipelineFilter, ProcessObject);

  void RegisterInternalFilter(GenericFilterType *filter, float weight);

  void UnregisterAllFilters();

  void ResetProgress();

  void ResetFilterProgressAndKeepAccumulatedProgress();

protected:
  ProgressAccumulator();
  virtual ~ProgressAccumulator();
  void PrintSelf(std::ostream & s, Indent indent) const;

private:
  typedef MemberCommand< Self > CommandType;
  typedef CommandType::Pointer  CommandPointer;

  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 IterationObserverTag;

    // The progress accumulated by the filter since last Reset()
    float Progress;
  };

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

  GenericFilterPointer m_MiniPipelineFilter;

  typedef std::vector< struct FilterRecord > FilterRecordVector;

  float m_AccumulatedProgress;

  float m_BaseAccumulatedProgress;

  FilterRecordVector m_FilterRecord;

  CommandPointer m_CallbackCommand;
};
} // End namespace itk

#endif // __itkProgressAccumulator_h_