ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkProgressAccumulator.h>
Facilitates progress reporting for filters that wrap around multiple other filters.
This object allows a mini-pipeline filters to easily keep track of the progress performed by the internal filters. See DiscreteGaussianImageFilter.hxx for an implementation example.
Definition at line 40 of file itkProgressAccumulator.h.
Classes | |
struct | FilterRecord |
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef GenericFilterType::Pointer | GenericFilterPointer |
typedef ProcessObject | GenericFilterType |
typedef SmartPointer< Self > | Pointer |
typedef ProgressAccumulator | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual float | GetAccumulatedProgress () const |
virtual const ProcessObject * | GetMiniPipelineFilter () const |
virtual ProcessObject * | GetModifiableMiniPipelineFilter () |
virtual const char * | GetNameOfClass () const |
void | RegisterInternalFilter (GenericFilterType *filter, float weight) |
void | ResetFilterProgressAndKeepAccumulatedProgress () |
void | ResetProgress () |
virtual void | SetMiniPipelineFilter (ProcessObject *_arg) |
void | UnregisterAllFilters () |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
void | PrintSelf (std::ostream &s, Indent indent) const |
ProgressAccumulator () | |
virtual | ~ProgressAccumulator () |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Types | |
typedef CommandType::Pointer | CommandPointer |
typedef MemberCommand< Self > | CommandType |
typedef std::vector< struct FilterRecord > | FilterRecordVector |
Private Member Functions | |
void | ReportProgress (Object *object, const EventObject &event) |
Private Attributes | |
float | m_AccumulatedProgress |
float | m_BaseAccumulatedProgress |
CommandPointer | m_CallbackCommand |
FilterRecordVector | m_FilterRecord |
GenericFilterPointer | m_MiniPipelineFilter |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
|
private |
Definition at line 97 of file itkProgressAccumulator.h.
|
private |
Command for observing progress of pipeline filters
Definition at line 96 of file itkProgressAccumulator.h.
typedef SmartPointer< const Self > itk::ProgressAccumulator::ConstPointer |
Definition at line 48 of file itkProgressAccumulator.h.
|
private |
An array of record structures
Definition at line 122 of file itkProgressAccumulator.h.
Definition at line 52 of file itkProgressAccumulator.h.
Typedef for inputting filters
Definition at line 51 of file itkProgressAccumulator.h.
typedef SmartPointer< Self > itk::ProgressAccumulator::Pointer |
Definition at line 47 of file itkProgressAccumulator.h.
Standard class typedefs.
Definition at line 45 of file itkProgressAccumulator.h.
Definition at line 46 of file itkProgressAccumulator.h.
|
protected |
|
protectedvirtual |
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
|
virtual |
Get the total progress accumulated by this object
|
virtual |
|
virtual |
Set the mini-pipeline filter
|
virtual |
Runtime information support.
Reimplemented from itk::Object.
|
static |
Standard New method.
|
protectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::Object.
void itk::ProgressAccumulator::RegisterInternalFilter | ( | GenericFilterType * | filter, |
float | weight | ||
) |
Register a filter with the progress accumulator and specify the fraction of the overall progress associated with this filter
|
private |
A callback function that is called by the progressing filters
void itk::ProgressAccumulator::ResetFilterProgressAndKeepAccumulatedProgress | ( | ) |
void itk::ProgressAccumulator::ResetProgress | ( | ) |
Reset the progress accumulator. This method should be called in the beginning of the GenerateData() method in the mini-pipeline filter.
|
virtual |
Set the mini-pipeline filter
void itk::ProgressAccumulator::UnregisterAllFilters | ( | ) |
Unregister all filters that have been registered with this object
|
private |
The total accumulated progress
Definition at line 125 of file itkProgressAccumulator.h.
|
private |
The total accumulated progress for multiple runs of the mini-pipeline
Definition at line 128 of file itkProgressAccumulator.h.
|
private |
The callback command
Definition at line 137 of file itkProgressAccumulator.h.
|
private |
A list of progress proportions of the different filters in the pipeline
Definition at line 134 of file itkProgressAccumulator.h.
|
private |
The client mini-pipeline filter
Definition at line 119 of file itkProgressAccumulator.h.