#include <elxProgressCommand.h>

Detailed Description

A specialized Command object for updating the progress of a filter.

There are 3 ways to use this class.

Whenever a filter, such as the itk::ResampleImageFilter, supports a ProgressReporter, this class can be employed. This class makes sure that the progress of a filter is printed to screen. It works as follows:

ProgressCommandType::Pointer command = ProgressCommandType::New();
command->ConnectObserver( filterpointer );
command->SetStartString( "  Progress: " );
command->SetEndString( "%" );
filterpointer->Update(); // run the filter, progress messages are printed now
command->DisconnectObserver( filterPointer );

So, first an instantiation of this class is created, then it is connected to a filter, and some options are set. Whenever the filter throws a ProgressEvent(), this class asks for the progress and prints the percentage of progress.

In manually written loops, a call to UpdateAndPrintProgress() can be included. Before the loop, the user should set the total number of loops, and the frequency that the progress message should be printed with. For example

ProgressCommandType::Pointer command = ProgressCommandType::New();
command->SetUpdateFrequency( maxnrofvoxels, 100 );
command->SetStartString( "  Progress: " );
command->SetEndString( "%" );
elxout << "Looping over voxels... " << std::endl;
for ( unsigned int i =0; i < maxnrofvoxels; ++i )
{
  command->UpdateAndPrintProgress( i );
}
command->PrintProgress(1.0); // make sure the 100% is reached

The last possibility is to directly use the PrintProgress function:

ProgressCommandType::Pointer command = ProgressCommandType::New();
command->SetStartString( "  Progress: " );
command->SetEndString( "%" );
elxout << "Reading, casting, writing..."
command->PrintProgress( 0.0 );
reader->Update();
command->PrintProgress( 0.33 );
caster->Update();
command->PrintProgress( 0.67 );
writer->Update();
command->PrintProgress( 1.0 );
// example assumes reader, caster and writer have been configured before

Definition at line 90 of file elxProgressCommand.h.

Inheritance diagram for elastix::ProgressCommand:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

typedef ProcessObjectType::Pointer	ProcessObjectPointer

typedef itk::ProcessObject	ProcessObjectType

typedef ProgressCommand	Self

typedef itk::Command	Superclass

Public Member Functions
virtual void	ConnectObserver (itk::ProcessObject *filter)

virtual void	DisconnectObserver (itk::ProcessObject *filter)

void	Execute (const itk::Object *caller, const itk::EventObject &event) override

void	Execute (itk::Object *caller, const itk::EventObject &event) override

virtual const char *	GetClassName () const

virtual const char *	GetEndString () const

virtual const char *	GetStartString () const

virtual const bool &	GetStreamOutputIsConsole ()

virtual void	PrintProgress (const float &progress) const

virtual void	SetEndString (const char *_arg)

virtual void	SetStartString (const char *_arg)

virtual void	SetUpdateFrequency (const unsigned long numberOfVoxels, const unsigned long numberOfUpdates)

virtual void	UpdateAndPrintProgress (const unsigned long &currentVoxelNumber) const

Static Public Member Functions
static Pointer	CreateAndConnect (itk::ProcessObject &)

static Pointer	CreateAndSetUpdateFrequency (unsigned long numberOfVoxels)

static Pointer	New ()

Protected Member Functions
	ProgressCommand ()

	~ProgressCommand () override

Private Attributes
std::string	m_EndString

unsigned long	m_NumberOfUpdates

unsigned long	m_NumberOfVoxels

ProcessObjectPointer	m_ObservedProcessObject

std::string	m_StartString

bool	m_StreamOutputIsConsole

unsigned long	m_Tag

bool	m_TagIsSet

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > elastix::ProgressCommand::ConstPointer

Definition at line 98 of file elxProgressCommand.h.

◆ Pointer

typedef itk::SmartPointer< Self > elastix::ProgressCommand::Pointer

Definition at line 97 of file elxProgressCommand.h.

◆ ProcessObjectPointer

typedef ProcessObjectType::Pointer elastix::ProgressCommand::ProcessObjectPointer

Definition at line 106 of file elxProgressCommand.h.

◆ ProcessObjectType

typedef itk::ProcessObject elastix::ProgressCommand::ProcessObjectType

Typedef's.

Definition at line 105 of file elxProgressCommand.h.

◆ Self

typedef ProgressCommand elastix::ProgressCommand::Self

Smart pointer declaration methods.

Definition at line 95 of file elxProgressCommand.h.

◆ Superclass

typedef itk::Command elastix::ProgressCommand::Superclass

Definition at line 96 of file elxProgressCommand.h.

Constructor & Destructor Documentation

◆ ProgressCommand()

elastix::ProgressCommand::ProgressCommand ( )

protected

The constructor.

◆ ~ProgressCommand()

elastix::ProgressCommand::~ProgressCommand ( )

overrideprotected

The destructor.

Member Function Documentation

◆ ConnectObserver()

virtual void elastix::ProgressCommand::ConnectObserver ( itk::ProcessObject * filter )

virtual

Connect an observer to a process object.

◆ CreateAndConnect()

static Pointer elastix::ProgressCommand::CreateAndConnect ( itk::ProcessObject & )

static

◆ CreateAndSetUpdateFrequency()

static Pointer elastix::ProgressCommand::CreateAndSetUpdateFrequency ( unsigned long numberOfVoxels )

static

◆ DisconnectObserver()

virtual void elastix::ProgressCommand::DisconnectObserver ( itk::ProcessObject * filter )

virtual

Disconnect an observer to a process object.

◆ Execute() [1/2]

void elastix::ProgressCommand::Execute	(	const itk::Object *	caller,
		const itk::EventObject &	event
	)

override

◆ Execute() [2/2]

void elastix::ProgressCommand::Execute	(	itk::Object *	caller,
		const itk::EventObject &	event
	)

override

Standard Command virtual methods.

◆ GetClassName()

virtual const char * elastix::ProgressCommand::GetClassName ( ) const

virtual

Standard ITK stuff.

◆ GetEndString()

virtual const char * elastix::ProgressCommand::GetEndString ( ) const

virtual

◆ GetStartString()

virtual const char * elastix::ProgressCommand::GetStartString ( ) const

virtual

◆ GetStreamOutputIsConsole()

virtual const bool & elastix::ProgressCommand::GetStreamOutputIsConsole ( )

virtual

Get a boolean indicating if the output is a console.

◆ New()

static Pointer elastix::ProgressCommand::New ( )

static

◆ PrintProgress()

virtual void elastix::ProgressCommand::PrintProgress ( const float & progress ) const

virtual

Print the progress to screen. A float value between 0.0 and 1.0 is expected as input.

◆ SetEndString()

virtual void elastix::ProgressCommand::SetEndString ( const char * _arg )

virtual

Set and get the string ending each progress report.

◆ SetStartString()

virtual void elastix::ProgressCommand::SetStartString ( const char * _arg )

virtual

Set and get the string starting each progress report.

◆ SetUpdateFrequency()

virtual void elastix::ProgressCommand::SetUpdateFrequency	(	const unsigned long	numberOfVoxels,
		const unsigned long	numberOfUpdates
	)

virtual

Define when to print the progress.

◆ UpdateAndPrintProgress()

virtual void elastix::ProgressCommand::UpdateAndPrintProgress ( const unsigned long & currentVoxelNumber ) const

virtual

Update and possibly print the progress to screen. The progress information on screen is refreshed according to the UpdateFrequency, which is assumed being specified beforehand using the SetUpdateFrequency function.

Field Documentation

◆ m_EndString

std::string elastix::ProgressCommand::m_EndString

private

Definition at line 163 of file elxProgressCommand.h.

◆ m_NumberOfUpdates

unsigned long elastix::ProgressCommand::m_NumberOfUpdates

private

Definition at line 173 of file elxProgressCommand.h.

◆ m_NumberOfVoxels

unsigned long elastix::ProgressCommand::m_NumberOfVoxels

private

Member variables that define the update frequency.

Definition at line 172 of file elxProgressCommand.h.

◆ m_ObservedProcessObject

ProcessObjectPointer elastix::ProgressCommand::m_ObservedProcessObject

private

Definition at line 169 of file elxProgressCommand.h.

◆ m_StartString

std::string elastix::ProgressCommand::m_StartString

private

Member variables to define a start and end string for printing.

Definition at line 162 of file elxProgressCommand.h.

◆ m_StreamOutputIsConsole

bool elastix::ProgressCommand::m_StreamOutputIsConsole

private

Member variables to keep track of what is set.

Definition at line 166 of file elxProgressCommand.h.

◆ m_Tag

unsigned long elastix::ProgressCommand::m_Tag

private

Definition at line 167 of file elxProgressCommand.h.

◆ m_TagIsSet

bool elastix::ProgressCommand::m_TagIsSet

private

Definition at line 168 of file elxProgressCommand.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ ProcessObjectPointer

◆ ProcessObjectType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ProgressCommand()

◆ ~ProgressCommand()

Member Function Documentation

◆ ConnectObserver()

◆ CreateAndConnect()

◆ CreateAndSetUpdateFrequency()

◆ DisconnectObserver()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ GetClassName()

◆ GetEndString()

◆ GetStartString()

◆ GetStreamOutputIsConsole()

◆ New()

◆ PrintProgress()

◆ SetEndString()

◆ SetStartString()

◆ SetUpdateFrequency()

◆ UpdateAndPrintProgress()

Field Documentation

◆ m_EndString

◆ m_NumberOfUpdates

◆ m_NumberOfVoxels

◆ m_ObservedProcessObject

◆ m_StartString

◆ m_StreamOutputIsConsole

◆ m_Tag

◆ m_TagIsSet