#include <itkCommandIterationUpdatev4.h>

Detailed Description

template<typename TOptimizer>
class itk::CommandIterationUpdatev4< TOptimizer >

Implementation of the Command Pattern to be invoked every iteration.

Definition at line 33 of file itkCommandIterationUpdatev4.h.

Inheritance diagram for itk::CommandIterationUpdatev4< TOptimizer >:

Collaboration diagram for itk::CommandIterationUpdatev4< TOptimizer >:

Public Types
using	ConstPointer = itk::SmartPointer<const Self>

using	OptimizerType = TOptimizer

using	Pointer = itk::SmartPointer<Self>

using	Self = CommandIterationUpdatev4

using	Superclass = itk::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 itk::Object *, const itk::EventObject &event) override

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

const char *	GetNameOfClass () const override

void	SetOptimizer (OptimizerType *optimizer)


virtual void	SetPrintParameters (bool _arg)

virtual bool	GetPrintParameters ()

virtual void	PrintParametersOn ()

virtual void	PrintParametersOff ()

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

const char *	GetNameOfClass () const override

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

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	CommandIterationUpdatev4 ()

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 &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
WeakPointer< OptimizerType >	m_Optimizer {}

bool	m_PrintParameters { false }

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TOptimizer>

using itk::CommandIterationUpdatev4< TOptimizer >::ConstPointer = itk::SmartPointer<const Self>

ConstSmart pointer type alias support

Definition at line 56 of file itkCommandIterationUpdatev4.h.

◆ OptimizerType

template<typename TOptimizer>

using itk::CommandIterationUpdatev4< TOptimizer >::OptimizerType = TOptimizer

Type defining the optimizer

Definition at line 113 of file itkCommandIterationUpdatev4.h.

◆ Pointer

template<typename TOptimizer>

using itk::CommandIterationUpdatev4< TOptimizer >::Pointer = itk::SmartPointer<Self>

Smart pointer type alias support

Definition at line 51 of file itkCommandIterationUpdatev4.h.

◆ Self

template<typename TOptimizer>

using itk::CommandIterationUpdatev4< TOptimizer >::Self = CommandIterationUpdatev4

Standard "Self" typedef.

Definition at line 39 of file itkCommandIterationUpdatev4.h.

◆ Superclass

template<typename TOptimizer>

using itk::CommandIterationUpdatev4< TOptimizer >::Superclass = itk::Command

Standard "Superclass" typedef.

Definition at line 45 of file itkCommandIterationUpdatev4.h.

Constructor & Destructor Documentation

◆ CommandIterationUpdatev4()

template<typename TOptimizer>

itk::CommandIterationUpdatev4< TOptimizer >::CommandIterationUpdatev4 ( )

inlineprotected

Constructor

Definition at line 139 of file itkCommandIterationUpdatev4.h.

Referenced by GetNameOfClass().

Member Function Documentation

◆ CreateAnother()

template<typename TOptimizer>

virtual::itk::LightObject::Pointer itk::CommandIterationUpdatev4< TOptimizer >::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::LightObject.

◆ Execute() [1/2]

template<typename TOptimizer>

void itk::CommandIterationUpdatev4< TOptimizer >::Execute	(	const itk::Object *	caller,
		const itk::EventObject &	event )

inlineoverridevirtual

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.

Definition at line 68 of file itkCommandIterationUpdatev4.h.

References m_Optimizer, and m_PrintParameters.

◆ Execute() [2/2]

template<typename TOptimizer>

void itk::CommandIterationUpdatev4< TOptimizer >::Execute	(	itk::Object *	caller,
		const itk::EventObject &	event )

inlineoverridevirtual

Execute method will print data at each iteration

Implements itk::Command.

Definition at line 62 of file itkCommandIterationUpdatev4.h.

References Execute().

Referenced by Execute().

◆ GetNameOfClass()

template<typename TOptimizer>

const char * itk::CommandIterationUpdatev4< TOptimizer >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::Command.

References CommandIterationUpdatev4().

◆ GetPrintParameters()

template<typename TOptimizer>

virtual bool itk::CommandIterationUpdatev4< TOptimizer >::GetPrintParameters ( )

virtual

Print parameters at each iteration

◆ New()

template<typename TOptimizer>

static Pointer itk::CommandIterationUpdatev4< TOptimizer >::New ( )

static

Method for creation through the object factory.

◆ PrintParametersOff()

template<typename TOptimizer>

virtual void itk::CommandIterationUpdatev4< TOptimizer >::PrintParametersOff ( )

virtual

Print parameters at each iteration

◆ PrintParametersOn()

template<typename TOptimizer>

virtual void itk::CommandIterationUpdatev4< TOptimizer >::PrintParametersOn ( )

virtual

Print parameters at each iteration

◆ SetOptimizer()

template<typename TOptimizer>

void itk::CommandIterationUpdatev4< TOptimizer >::SetOptimizer ( OptimizerType * optimizer )

inline

Set Optimizer

Definition at line 120 of file itkCommandIterationUpdatev4.h.

References m_Optimizer.

◆ SetPrintParameters()

template<typename TOptimizer>

virtual void itk::CommandIterationUpdatev4< TOptimizer >::SetPrintParameters ( bool _arg )

virtual

Print parameters at each iteration

Member Data Documentation

◆ m_Optimizer

template<typename TOptimizer>

WeakPointer<OptimizerType> itk::CommandIterationUpdatev4< TOptimizer >::m_Optimizer {}

private

WeakPointer to the Optimizer

Definition at line 145 of file itkCommandIterationUpdatev4.h.

Referenced by Execute(), and SetOptimizer().

◆ m_PrintParameters

template<typename TOptimizer>

bool itk::CommandIterationUpdatev4< TOptimizer >::m_PrintParameters { false }

private

Definition at line 147 of file itkCommandIterationUpdatev4.h.

Referenced by Execute().

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

itkCommandIterationUpdatev4.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ OptimizerType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ CommandIterationUpdatev4()

Member Function Documentation

◆ CreateAnother()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ GetNameOfClass()

◆ GetPrintParameters()

◆ New()

◆ PrintParametersOff()

◆ PrintParametersOn()

◆ SetOptimizer()

◆ SetPrintParameters()

Member Data Documentation

◆ m_Optimizer

◆ m_PrintParameters