itk::SimpleFilterWatcher Class Reference

Simple mechanism for monitoring the pipeline events of a filter and reporting these events to std::cout. More...

#include <itkSimpleFilterWatcher.h>

Collaboration diagram for itk::SimpleFilterWatcher:

[legend]List of all members.

Public Member Functions
	SimpleFilterWatcher (itk::ProcessObject *o, const char *comment="")
	SimpleFilterWatcher (const SimpleFilterWatcher &)
	SimpleFilterWatcher ()
void	operator= (const SimpleFilterWatcher &)
virtual	~SimpleFilterWatcher ()
const char *	GetNameOfClass ()
void	QuietOn ()
void	QuietOff ()
void	TestAbortOn ()
void	TestAbortOff ()
Protected Member Functions
virtual void	ShowAbort ()
virtual void	ShowIteration ()
virtual void	ShowProgress ()
virtual void	StartFilter ()
virtual void	EndFilter ()

---

Detailed Description

Simple mechanism for monitoring the pipeline events of a filter and reporting these events to std::cout.

SimpleFilterWatcher provides a simple mechanism for monitoring the execution of filter. SimpleFilterWatcher is a stack-based object which takes a pointer to a ProcessObject at constructor time. SimpleFilterWatcher creates a series of commands that are registered as observers to the specified ProcessObject. The events monitored are:

StartEvent EndEvent ProgressEvent IterationEvent AbortEvent

The callbacks routines registered for these events emit a simple message to std::cout.

Example of use:

typedef itk::BinaryThresholdImageFilter<ImageType> FilterType; FilterType::Pointer thresholdFilter = FilterType::New();

SimpleFilterWatcher watcher(thresholdFilter, "Threshold");

The second argument to the constructor to SimpleFilterWatcher is an optional string that is prepended to the event messages. This allows the user to associate the emitted messages to a particular filter/variable.

Todo:

Allow any stream object to be used for the output (not just std::cout)

Definition at line 63 of file itkSimpleFilterWatcher.h.

---

Constructor & Destructor Documentation

itk::SimpleFilterWatcher::SimpleFilterWatcher (  itk::ProcessObject *  o, const char *  comment = "" )

Constructor. Takes a ProcessObject to monitor and an optional comment string that is prepended to each event message.

itk::SimpleFilterWatcher::SimpleFilterWatcher (  const SimpleFilterWatcher &   )

Copy constructor

itk::SimpleFilterWatcher::SimpleFilterWatcher (   )

Default constructor. Only provided so that you can have std::vectors of SimpleFilterWatchers.

virtual itk::SimpleFilterWatcher::~SimpleFilterWatcher (   )  [virtual]

Destructor.

---

Member Function Documentation

virtual void itk::SimpleFilterWatcher::EndFilter (   )  [inline, protected, virtual]

Callback method to show the EndEvent Definition at line 167 of file itkSimpleFilterWatcher.h.

const char* itk::SimpleFilterWatcher::GetNameOfClass (   )  [inline]

Method to get the name of the class be monitored by this SimpleFilterWatcher Definition at line 85 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::operator= (  const SimpleFilterWatcher &   )

operator=

void itk::SimpleFilterWatcher::QuietOff (   )  [inline]

Methods to control the verbosity of the messages. Quiet reporting limits the information emitted at a ProgressEvent. Definition at line 93 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::QuietOn (   )  [inline]

Methods to control the verbosity of the messages. Quiet reporting limits the information emitted at a ProgressEvent. Definition at line 92 of file itkSimpleFilterWatcher.h.

virtual void itk::SimpleFilterWatcher::ShowAbort (   )  [inline, protected, virtual]

Callback method to show the AbortEvent Definition at line 132 of file itkSimpleFilterWatcher.h.

virtual void itk::SimpleFilterWatcher::ShowIteration (   )  [inline, protected, virtual]

Callback method to show the IterationEvent Definition at line 138 of file itkSimpleFilterWatcher.h.

virtual void itk::SimpleFilterWatcher::ShowProgress (   )  [inline, protected, virtual]

Callback method to show the ProgressEvent Definition at line 107 of file itkSimpleFilterWatcher.h.

virtual void itk::SimpleFilterWatcher::StartFilter (   )  [inline, protected, virtual]

Callback method to show the StartEvent Definition at line 145 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::TestAbortOff (   )  [inline]

Methods to use to test the AbortEvent of the a filter. If TestAbort is on, the filter being watched will be aborted when the progress reaches 30%. Definition at line 100 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::TestAbortOn (   )  [inline]

Methods to use to test the AbortEvent of the a filter. If TestAbort is on, the filter being watched will be aborted when the progress reaches 30%. Definition at line 99 of file itkSimpleFilterWatcher.h.

---

The documentation for this class was generated from the following file:

• itkSimpleFilterWatcher.h

---