RTK  2.6.0
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rtk::OutputIterationCommand< TCaller, TOutputImage > Class Template Reference

#include <rtkIterationCommands.h>

+ Inheritance diagram for rtk::OutputIterationCommand< TCaller, TOutputImage >:
+ Collaboration diagram for rtk::OutputIterationCommand< TCaller, TOutputImage >:

Public Types

typedef itk::SmartPointer< SelfPointer
 
typedef OutputIterationCommand Self
 
typedef IterationCommand< TCaller > Superclass
 
- Public Types inherited from rtk::IterationCommand< TCaller >
typedef itk::SmartPointer< SelfPointer
 
typedef IterationCommand Self
 
typedef itk::Command Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetFileFormat (std::string _arg)
 
- Public Member Functions inherited from rtk::IterationCommand< TCaller >
void Execute (itk::Object *caller, const itk::EventObject &event) override
 
void Execute (const itk::Object *caller, const itk::EventObject &event) override
 
virtual void SetTriggerEvery (unsigned int _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void Run (const TCaller *caller) override
 
- Protected Member Functions inherited from rtk::IterationCommand< TCaller >
virtual void End (const TCaller *)
 

Protected Attributes

std::string m_FileFormat
 
- Protected Attributes inherited from rtk::IterationCommand< TCaller >
unsigned int m_IterationCount = 0
 
unsigned int m_TriggerEvery = 1
 

Detailed Description

template<typename TCaller, typename TOutputImage>
class rtk::OutputIterationCommand< TCaller, TOutputImage >

Output intermediate iterations in a file. This class is useful to check convergence of an iterative method and to avoid starting over similar computations when testing hyperparameters of an iterative algorithm.

Author
Aurélien Coussat

Definition at line 139 of file rtkIterationCommands.h.

Member Typedef Documentation

◆ Pointer

template<typename TCaller , typename TOutputImage >
typedef itk::SmartPointer<Self> rtk::OutputIterationCommand< TCaller, TOutputImage >::Pointer

Definition at line 145 of file rtkIterationCommands.h.

◆ Self

template<typename TCaller , typename TOutputImage >
typedef OutputIterationCommand rtk::OutputIterationCommand< TCaller, TOutputImage >::Self

Standard class typedefs.

Definition at line 143 of file rtkIterationCommands.h.

◆ Superclass

template<typename TCaller , typename TOutputImage >
typedef IterationCommand<TCaller> rtk::OutputIterationCommand< TCaller, TOutputImage >::Superclass

Definition at line 144 of file rtkIterationCommands.h.

Member Function Documentation

◆ CreateAnother()

template<typename TCaller , typename TOutputImage >
virtual::itk::LightObject::Pointer rtk::OutputIterationCommand< TCaller, TOutputImage >::CreateAnother ( ) const
virtual

Reimplemented from itk::Object.

◆ New()

template<typename TCaller , typename TOutputImage >
static Pointer rtk::OutputIterationCommand< TCaller, TOutputImage >::New ( )
static

◆ Run()

template<typename TCaller , typename TOutputImage >
void rtk::OutputIterationCommand< TCaller, TOutputImage >::Run ( const TCaller *  caller)
inlineoverrideprotectedvirtual

Callback function to be redefined by derived classes.

Implements rtk::IterationCommand< TCaller >.

Definition at line 155 of file rtkIterationCommands.h.

◆ SetFileFormat()

template<typename TCaller , typename TOutputImage >
virtual void rtk::OutputIterationCommand< TCaller, TOutputImage >::SetFileFormat ( std::string  _arg)
virtual

Member Data Documentation

◆ m_FileFormat

template<typename TCaller , typename TOutputImage >
std::string rtk::OutputIterationCommand< TCaller, TOutputImage >::m_FileFormat
protected

Output file name, where d is the current iteration number

Definition at line 148 of file rtkIterationCommands.h.


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