ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate > Class Template Reference

#include <itkLevelSetIterationUpdateCommand.h>

+ Inheritance diagram for itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >:
+ Collaboration diagram for itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >:

Detailed Description

template<typename TIteratingFilter, typename TFilterToUpdate>
class itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >

Call update on one filter when another filter iterates.

Template Parameters
TIteratingFilterFilter that invokes iteration events.
TFilterToUpdateFilter to call update on when the iteration event occurs.
Examples:
SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, and SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx.

Definition at line 38 of file itkLevelSetIterationUpdateCommand.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FilterToUpdateType = TFilterToUpdate
 
using IteratingFilterType = TIteratingFilter
 
using Pointer = SmartPointer< Self >
 
using Self = LevelSetIterationUpdateCommand
 
using Superclass = Command
 
- 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
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void Execute (const Object *caller, const EventObject &event) override
 
void Execute (Object *caller, const EventObject &event) override
 
virtual const char * GetNameOfClass () const
 
virtual void SetFilterToUpdate (FilterToUpdateType *_arg)
 
virtual FilterToUpdateTypeGetModifiableFilterToUpdate ()
 
virtual const FilterToUpdateTypeGetFilterToUpdate () const
 
virtual void SetUpdatePeriod (IdentifierType _arg)
 
virtual IdentifierType GetUpdatePeriod () const
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
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
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

 LevelSetIterationUpdateCommand ()
 
 ~LevelSetIterationUpdateCommand () override
 
- 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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

WeakPointer< FilterToUpdateTypem_FilterToUpdate
 
IdentifierType m_UpdatePeriod
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::ConstPointer = SmartPointer< const Self >

Definition at line 46 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::FilterToUpdateType = TFilterToUpdate

Definition at line 49 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::IteratingFilterType = TIteratingFilter

Definition at line 48 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::Pointer = SmartPointer< Self >

Definition at line 45 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::Self = LevelSetIterationUpdateCommand

Definition at line 43 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
using itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::Superclass = Command

Definition at line 44 of file itkLevelSetIterationUpdateCommand.h.

Constructor & Destructor Documentation

template<typename TIteratingFilter , typename TFilterToUpdate >
itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::LevelSetIterationUpdateCommand ( )
protected
template<typename TIteratingFilter , typename TFilterToUpdate >
itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::~LevelSetIterationUpdateCommand ( )
overrideprotected

Member Function Documentation

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual::itk::LightObject::Pointer itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::CreateAnother ( ) const
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.

template<typename TIteratingFilter , typename TFilterToUpdate >
void itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::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.

template<typename TIteratingFilter , typename TFilterToUpdate >
void itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::Execute ( Object caller,
const EventObject event 
)
overridevirtual

Abstract method that defines the action to be taken by the command.

Implements itk::Command.

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual const FilterToUpdateType* itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::GetFilterToUpdate ( ) const
virtual

Set/Get the filter to call Update() on.

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual FilterToUpdateType* itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::GetModifiableFilterToUpdate ( )
virtual

Set/Get the filter to call Update() on.

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual const char* itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Command.

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual IdentifierType itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::GetUpdatePeriod ( ) const
virtual

Set/Get the period that Update() is called on the FilterToUpdate. It is in units of iterations.

template<typename TIteratingFilter , typename TFilterToUpdate >
static Pointer itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::New ( )
static
template<typename TIteratingFilter , typename TFilterToUpdate >
virtual void itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::SetFilterToUpdate ( FilterToUpdateType _arg)
virtual

Set/Get the filter to call Update() on.

template<typename TIteratingFilter , typename TFilterToUpdate >
virtual void itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::SetUpdatePeriod ( IdentifierType  _arg)
virtual

Set/Get the period that Update() is called on the FilterToUpdate. It is in units of iterations.

Member Data Documentation

template<typename TIteratingFilter , typename TFilterToUpdate >
WeakPointer< FilterToUpdateType > itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::m_FilterToUpdate
private

Definition at line 76 of file itkLevelSetIterationUpdateCommand.h.

template<typename TIteratingFilter , typename TFilterToUpdate >
IdentifierType itk::LevelSetIterationUpdateCommand< TIteratingFilter, TFilterToUpdate >::m_UpdatePeriod
private

Definition at line 77 of file itkLevelSetIterationUpdateCommand.h.


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