ITK  6.0.0
Insight Toolkit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::WatershedMiniPipelineProgressCommand Class Reference
Group Segmentation » Module ITKWatersheds

#include <itkWatershedMiniPipelineProgressCommand.h>

Detailed Description

A specialized Command object for updating the progress of a MiniPipeline. Follows the progress of a series of filters and calls UpdateProgress on another filter (i.e. the filter implementing the mini-pipeline).

Definition at line 34 of file itkWatershedMiniPipelineProgressCommand.h.

+ Inheritance diagram for itk::WatershedMiniPipelineProgressCommand:
+ Collaboration diagram for itk::WatershedMiniPipelineProgressCommand:

Public Member Functions

void Execute (const Object *caller, const EventObject &event) override
 
void Execute (Object *caller, const EventObject &event) override
 
void SetFilter (ProcessObject *p)
 
const ProcessObject * GetFilter ()
 
virtual void SetCount (double _arg)
 
virtual double GetCount () const
 
virtual void SetNumberOfFilters (unsigned int _arg)
 
virtual unsigned int GetNumberOfFilters () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 WatershedMiniPipelineProgressCommand ()=default
 
 ~WatershedMiniPipelineProgressCommand () override=default
 
- Protected Member Functions inherited from itk::Command
 Command ()
 
 ~Command () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 Attributes

double m_Count { 0.0 }
 
ProcessObject * m_Filter { nullptr }
 
unsigned int m_NumberOfFilters { 1 }
 
using Self = WatershedMiniPipelineProgressCommand
 
using Superclass = Command
 
using Pointer = itk::SmartPointer< Self >
 
using ConstPointer = itk::SmartPointer< const Self >
 
const char * GetNameOfClass () const override
 
static Pointer New ()
 

Additional Inherited Members

- Public Types inherited from itk::Command
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Command
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

using itk::WatershedMiniPipelineProgressCommand::ConstPointer = itk::SmartPointer<const Self>

Smart pointer declaration methods

Definition at line 41 of file itkWatershedMiniPipelineProgressCommand.h.

◆ Pointer

using itk::WatershedMiniPipelineProgressCommand::Pointer = itk::SmartPointer<Self>

Smart pointer declaration methods

Definition at line 40 of file itkWatershedMiniPipelineProgressCommand.h.

◆ Self

using itk::WatershedMiniPipelineProgressCommand::Self = WatershedMiniPipelineProgressCommand

Smart pointer declaration methods

Definition at line 38 of file itkWatershedMiniPipelineProgressCommand.h.

◆ Superclass

using itk::WatershedMiniPipelineProgressCommand::Superclass = Command

Smart pointer declaration methods

Definition at line 39 of file itkWatershedMiniPipelineProgressCommand.h.

Constructor & Destructor Documentation

◆ WatershedMiniPipelineProgressCommand()

itk::WatershedMiniPipelineProgressCommand::WatershedMiniPipelineProgressCommand ( )
protecteddefault

◆ ~WatershedMiniPipelineProgressCommand()

itk::WatershedMiniPipelineProgressCommand::~WatershedMiniPipelineProgressCommand ( )
overrideprotecteddefault

Member Function Documentation

◆ Execute() [1/2]

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

Abstract method that defines the action to be taken by the command. This variant is expected to be used when requests comes from a const Object

Implements itk::Command.

◆ Execute() [2/2]

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

Standard Command virtual methods

Implements itk::Command.

◆ GetCount()

virtual double itk::WatershedMiniPipelineProgressCommand::GetCount ( ) const
virtual

Set/Get the base count for stepping through filter progress values

◆ GetFilter()

const ProcessObject* itk::WatershedMiniPipelineProgressCommand::GetFilter ( )
inline

Set/Get the filter whose UpdateProgress will be set by this command object

Definition at line 61 of file itkWatershedMiniPipelineProgressCommand.h.

◆ GetNameOfClass()

const char* itk::WatershedMiniPipelineProgressCommand::GetNameOfClass ( ) const
overridevirtual

Smart pointer declaration methods

Reimplemented from itk::Command.

◆ GetNumberOfFilters()

virtual unsigned int itk::WatershedMiniPipelineProgressCommand::GetNumberOfFilters ( ) const
virtual

Set/Get the number of filters that this command will expect to be observing

◆ New()

static Pointer itk::WatershedMiniPipelineProgressCommand::New ( )
static

Smart pointer declaration methods

◆ PrintSelf()

void itk::WatershedMiniPipelineProgressCommand::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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.

◆ SetCount()

virtual void itk::WatershedMiniPipelineProgressCommand::SetCount ( double  _arg)
virtual

Set/Get the base count for stepping through filter progress values

◆ SetFilter()

void itk::WatershedMiniPipelineProgressCommand::SetFilter ( ProcessObject *  p)
inline

Set/Get the filter whose UpdateProgress will be set by this command object

Definition at line 56 of file itkWatershedMiniPipelineProgressCommand.h.

◆ SetNumberOfFilters()

virtual void itk::WatershedMiniPipelineProgressCommand::SetNumberOfFilters ( unsigned int  _arg)
virtual

Set/Get the number of filters that this command will expect to be observing

Member Data Documentation

◆ m_Count

double itk::WatershedMiniPipelineProgressCommand::m_Count { 0.0 }
private

Definition at line 85 of file itkWatershedMiniPipelineProgressCommand.h.

◆ m_Filter

ProcessObject* itk::WatershedMiniPipelineProgressCommand::m_Filter { nullptr }
private

Definition at line 86 of file itkWatershedMiniPipelineProgressCommand.h.

◆ m_NumberOfFilters

unsigned int itk::WatershedMiniPipelineProgressCommand::m_NumberOfFilters { 1 }
private

Definition at line 87 of file itkWatershedMiniPipelineProgressCommand.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16