FREE::IterationEventBase Class Reference
[Events]

Abstract event object for iteration events in f.r.e.e.. More...

#include <freRegistrationEvents.h>

Inheritance diagram for FREE::IterationEventBase:

[legend]

Collaboration diagram for FREE::IterationEventBase:

[legend]

List of all members.

Public Types
typedef void(*	NextIterationEvent )(const long &IterationStep, Statistics *pStatistic, void *pSender, long threadID)
typedef itk::SmartPointer < IterationEventBase >	Pointer
Public Member Functions
	freNewEventBaseMacro (IterationEventBase, NextIterationEvent)
	itkTypeMacro (IterationEventBase, NotificationEventBase)
virtual void	Execute (const long IterationStep, Statistics *pStatistic, void *pSender, long threadID=0)
Protected Member Functions
	IterationEventBase ()
	IterationEventBase (NextIterationEvent pNIE)
Private Attributes
NextIterationEvent	m_IterationEvent

---

Detailed Description

Abstract event object for iteration events in f.r.e.e..

IterationEventBase is the generic event object within f.r.e.e. and used for realize callbacks to nonstatic member functions of f.r.e.e. Objects.

Definition at line 38 of file freRegistrationEvents.h.

---

Member Typedef Documentation

typedef void(* FREE::IterationEventBase::NextIterationEvent)(const long &IterationStep, Statistics *pStatistic, void *pSender, long threadID)

Reimplemented in FREE::IterationEvent< T >, FREE::IterationEvent< FREE::ConsistencyRegistrationMetric< VImageDimension > >, FREE::IterationEvent< FREE::RegistrationProcessEventHandler >, and FREE::IterationEvent< FREE::SetupOptimizationMetric >.

Definition at line 41 of file freRegistrationEvents.h.

typedef itk::SmartPointer<IterationEventBase> FREE::IterationEventBase::Pointer

Reimplemented from FREE::NotificationEventBase.

Reimplemented in FREE::IterationEvent< T >, FREE::IterationEvent< FREE::ConsistencyRegistrationMetric< VImageDimension > >, FREE::IterationEvent< FREE::RegistrationProcessEventHandler >, and FREE::IterationEvent< FREE::SetupOptimizationMetric >.

Definition at line 43 of file freRegistrationEvents.h.

---

Constructor & Destructor Documentation

FREE::IterationEventBase::IterationEventBase

(

)

[protected]

Implementation of FREE::IterationEventBase /////////////////////////

Definition at line 35 of file freRegistrationEvents.cxx.

References m_IterationEvent.

FREE::IterationEventBase::IterationEventBase

(

NextIterationEvent

pNIE

)

[protected]

Definition at line 38 of file freRegistrationEvents.cxx.

References m_IterationEvent.

---

Member Function Documentation

FREE::IterationEventBase::freNewEventBaseMacro	(	IterationEventBase	,
		NextIterationEvent
	)

FREE::IterationEventBase::itkTypeMacro	(	IterationEventBase	,
		NotificationEventBase
	)

void FREE::IterationEventBase::Execute	(	const long	IterationStep,
		Statistics *	pStatistic,
		void *	pSender,
		long	threadID = 0
	)			[virtual]

Event type that is used, if an iteration is finished. The actual values and position of the optimizer are passed with the event. pSender is the pointer to the object how called the event.

Parameters:

[in]	IterationStep	Number of the iteration.
[in]	pSender	Pointer to the object, which called the event.
[in]	threadID	ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender.

Reimplemented in FREE::IterationEvent< T >, FREE::IterationEvent< FREE::ConsistencyRegistrationMetric< VImageDimension > >, FREE::IterationEvent< FREE::RegistrationProcessEventHandler >, and FREE::IterationEvent< FREE::SetupOptimizationMetric >.

Definition at line 45 of file freRegistrationEvents.cxx.

References m_IterationEvent.

---

Member Data Documentation

NextIterationEvent FREE::IterationEventBase::m_IterationEvent [private]

Reimplemented in FREE::IterationEvent< T >, FREE::IterationEvent< FREE::ConsistencyRegistrationMetric< VImageDimension > >, FREE::IterationEvent< FREE::RegistrationProcessEventHandler >, and FREE::IterationEvent< FREE::SetupOptimizationMetric >.

Definition at line 49 of file freRegistrationEvents.h.

Referenced by Execute(), and IterationEventBase().

---

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

• freRegistrationEvents.h
• freRegistrationEvents.cxx

---