elxProgressCommand.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __elxProgressCommand_h
#define __elxProgressCommand_h
 
#include "itkProcessObject.h"
#include "itkCommand.h"
 
namespace elastix
{
 
class ProgressCommand : public itk::Command
{
public:
 
  typedef ProgressCommand                 Self;
  typedef itk::Command                    Superclass;
  typedef itk::SmartPointer< Self >       Pointer;
  typedef itk::SmartPointer< const Self > ConstPointer;
 
  itkTypeMacro( ProgressCommand, Command );
  itkNewMacro( Self );
 
  typedef itk::ProcessObject         ProcessObjectType;
  typedef ProcessObjectType::Pointer ProcessObjectPointer;
 
  virtual void SetUpdateFrequency(
    const unsigned long numberOfVoxels,
    const unsigned long numberOfUpdates );
 
  virtual void ConnectObserver( itk::ProcessObject * filter );
 
  virtual void DisconnectObserver( itk::ProcessObject * filter );
 
  void Execute( itk::Object * caller, const itk::EventObject & event ) override;
 
  void Execute( const itk::Object * caller, const itk::EventObject & event ) override;
 
  virtual void PrintProgress( const float & progress ) const;
 
  virtual void UpdateAndPrintProgress( const unsigned long & currentVoxelNumber ) const;
 
  itkSetStringMacro( StartString );
  itkGetStringMacro( StartString );
 
  itkSetStringMacro( EndString );
  itkGetStringMacro( EndString );
 
  itkGetConstReferenceMacro( StreamOutputIsConsole, bool );
 
  static Pointer CreateAndSetUpdateFrequency(unsigned long numberOfVoxels);
 
  static Pointer CreateAndConnect(itk::ProcessObject&);
 
protected:
 
  ProgressCommand();
 
  ~ProgressCommand() override;
 
private:
 
  std::string m_StartString;
  std::string m_EndString;
 
  bool                 m_StreamOutputIsConsole;
  unsigned long        m_Tag;
  bool                 m_TagIsSet;
  ProcessObjectPointer m_ObservedProcessObject;
 
  unsigned long m_NumberOfVoxels;
  unsigned long m_NumberOfUpdates;
 
};
 
} // end namespace elastix
 
#endif // end #ifndef __elxProgressCommand_h