RTK  2.0.1
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rtk::NesterovUpdateImageFilter< TImage > Class Template Reference

#include <rtkNesterovUpdateImageFilter.h>

+ Inheritance diagram for rtk::NesterovUpdateImageFilter< TImage >:
+ Collaboration diagram for rtk::NesterovUpdateImageFilter< TImage >:

Public Types

using OutputImageRegionType = typename Superclass::OutputImageType::RegionType
 
using Pointer = itk::SmartPointer< Self >
 
using Self = NesterovUpdateImageFilter
 
using Superclass = itk::InPlaceImageFilter< TImage, TImage >
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual int GetNumberOfIterations ()
 
virtual void SetNumberOfIterations (int _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void GenerateInputRequestedRegion () override
 
 NesterovUpdateImageFilter ()
 
 ~NesterovUpdateImageFilter () override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType) override
 
void AfterThreadedGenerateData () override
 

Protected Attributes

TImage::Pointer m_Alphak
 
int m_CurrentIteration
 
bool m_MustInitializeIntermediateImages
 
int m_NumberOfIterations
 
TImage::PixelType::ValueType m_Ratio
 
TImage::PixelType::ValueType m_Sum
 
TImage::PixelType::ValueType m_tCoeff
 
TImage::PixelType::ValueType m_tCoeffNext
 
TImage::Pointer m_Vk
 

Detailed Description

template<typename TImage>
class rtk::NesterovUpdateImageFilter< TImage >

Applies Nesterov's momentum technique.

NesterovUpdateImageFilter implements Nesterov's momentum technique in order to accelerate the convergence rate of Newton's method, or other optimization algorithms. The first input is the current iterate, the second input is the product of the inverse hessian matrix by the gradient vector (the Newton's update, before applying a minus sign)

Author
Cyril Mory

Definition at line 42 of file rtkNesterovUpdateImageFilter.h.

Member Typedef Documentation

Convenient type alias

Definition at line 53 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
using rtk::NesterovUpdateImageFilter< TImage >::Pointer = itk::SmartPointer< Self >

Definition at line 50 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
using rtk::NesterovUpdateImageFilter< TImage >::Self = NesterovUpdateImageFilter

Standard class type alias.

Definition at line 48 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
using rtk::NesterovUpdateImageFilter< TImage >::Superclass = itk::InPlaceImageFilter< TImage, TImage>

Definition at line 49 of file rtkNesterovUpdateImageFilter.h.

Constructor & Destructor Documentation

template<typename TImage >
rtk::NesterovUpdateImageFilter< TImage >::NesterovUpdateImageFilter ( )
protected
template<typename TImage >
rtk::NesterovUpdateImageFilter< TImage >::~NesterovUpdateImageFilter ( )
overrideprotected

Member Function Documentation

template<typename TImage >
void rtk::NesterovUpdateImageFilter< TImage >::AfterThreadedGenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TImage >
void rtk::NesterovUpdateImageFilter< TImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TImage >
virtual::itk::LightObject::Pointer rtk::NesterovUpdateImageFilter< TImage >::CreateAnother ( ) const
virtual

Reimplemented from itk::Object.

template<typename TImage >
void rtk::NesterovUpdateImageFilter< TImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual
template<typename TImage >
virtual const char* rtk::NesterovUpdateImageFilter< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TImage >
virtual int rtk::NesterovUpdateImageFilter< TImage >::GetNumberOfIterations ( )
virtual

Get and Set macro

template<typename TImage >
static Pointer rtk::NesterovUpdateImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

template<typename TImage >
virtual void rtk::NesterovUpdateImageFilter< TImage >::SetNumberOfIterations ( int  _arg)
virtual
template<typename TImage >
void rtk::NesterovUpdateImageFilter< TImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType   
)
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

template<typename TImage >
TImage::Pointer rtk::NesterovUpdateImageFilter< TImage >::m_Alphak
protected

Definition at line 91 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
int rtk::NesterovUpdateImageFilter< TImage >::m_CurrentIteration
protected

Definition at line 82 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
bool rtk::NesterovUpdateImageFilter< TImage >::m_MustInitializeIntermediateImages
protected

Definition at line 83 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
int rtk::NesterovUpdateImageFilter< TImage >::m_NumberOfIterations
protected

Definition at line 81 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_Ratio
protected

Definition at line 87 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_Sum
protected

Definition at line 86 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_tCoeff
protected

Definition at line 84 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_tCoeffNext
protected

Definition at line 85 of file rtkNesterovUpdateImageFilter.h.

template<typename TImage >
TImage::Pointer rtk::NesterovUpdateImageFilter< TImage >::m_Vk
protected

Definition at line 90 of file rtkNesterovUpdateImageFilter.h.


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