ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter > Class Template Reference

#include <itkVariationalRegistrationLogger.h>

+ Inheritance diagram for itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >:
+ Collaboration diagram for itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >:

Detailed Description

template<typename TRegistrationFilter, typename TMRFilter>
class itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >

A simple callback/observer class to print information during the registration process.

VariationalRegistrationLogger is an implementation of the Command design pattern that is invoked every iteration of the registration process. Use AddObserver() to connect the logger with VariationalRegistrationFilter and/or VariationalRegistrationMultiResolutionFilter. VariationalRegistrationLogger prints levels or metric values on IterationEvent or InitializeEvent.

See Also
VariationalRegistrationFilter
VariationalRegistrationMultiResolutionFilter
Note
This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).
Author
Alexander Schmidt-Richberg
Rene Werner
Jan Ehrhardt

Definition at line 46 of file itkVariationalRegistrationLogger.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MRFilterType = TMRFilter
 
using Pointer = SmartPointer< Self >
 
using RegistrationFilterType = TRegistrationFilter
 
using Self = VariationalRegistrationLogger
 
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 (itk::Object *caller, const itk::EventObject &event) override
 
void Execute (const itk::Object *caller, const itk::EventObject &event) override
 
- Public Member Functions inherited from itk::Command
virtual const char * GetNameOfClass () 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

void PrintSelf (std::ostream &os, Indent indent) const override
 
 VariationalRegistrationLogger ()
 
 ~VariationalRegistrationLogger () 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
 
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 ()
 

Additional Inherited Members

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

Member Typedef Documentation

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::ConstPointer = SmartPointer< const Self >

Definition at line 56 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::MRFilterType = TMRFilter

Definition at line 60 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::Pointer = SmartPointer< Self >

Definition at line 55 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::RegistrationFilterType = TRegistrationFilter

Registration and MR filter types

Definition at line 59 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::Self = VariationalRegistrationLogger

Standard class type alias.

Definition at line 53 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
using itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::Superclass = Command

Definition at line 54 of file itkVariationalRegistrationLogger.h.

Constructor & Destructor Documentation

template<typename TRegistrationFilter , typename TMRFilter >
itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::VariationalRegistrationLogger ( )
protected
template<typename TRegistrationFilter , typename TMRFilter >
itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::~VariationalRegistrationLogger ( )
overrideprotected

Member Function Documentation

template<typename TRegistrationFilter , typename TMRFilter >
virtual::itk::LightObject::Pointer itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::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 TRegistrationFilter , typename TMRFilter >
void itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::Execute ( itk::Object caller,
const itk::EventObject event 
)
inlineoverridevirtual

Print iterations, levels or metric values on IterationEvent or InitializeEvent

Implements itk::Command.

Definition at line 66 of file itkVariationalRegistrationLogger.h.

template<typename TRegistrationFilter , typename TMRFilter >
void itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::Execute ( const itk::Object caller,
const itk::EventObject event 
)
overridevirtual

Print iterations, levels or metric values on IterationEvent or InitializeEvent

Implements itk::Command.

template<typename TRegistrationFilter , typename TMRFilter >
static Pointer itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::New ( )
static

Method for creation through the object factory.

template<typename TRegistrationFilter , typename TMRFilter >
void itk::VariationalRegistrationLogger< TRegistrationFilter, TMRFilter >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Print information about the filter.

Reimplemented from itk::Object.


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