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
const char *	GetNameOfClass () const override
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	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) 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

OutputImageRegionType

template<typename TImage >

using rtk::NesterovUpdateImageFilter< TImage >::OutputImageRegionType = typename Superclass::OutputImageType::RegionType

Convenient type alias

Definition at line 53 of file rtkNesterovUpdateImageFilter.h.

Pointer

template<typename TImage >

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

Definition at line 50 of file rtkNesterovUpdateImageFilter.h.

Self

template<typename TImage >

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

Standard class type alias.

Definition at line 48 of file rtkNesterovUpdateImageFilter.h.

Superclass

template<typename TImage >

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

Definition at line 49 of file rtkNesterovUpdateImageFilter.h.

Constructor & Destructor Documentation

NesterovUpdateImageFilter()

template<typename TImage >

rtk::NesterovUpdateImageFilter< TImage >::NesterovUpdateImageFilter ( )

protected

~NesterovUpdateImageFilter()

template<typename TImage >

rtk::NesterovUpdateImageFilter< TImage >::~NesterovUpdateImageFilter ( )

overrideprotected

Member Function Documentation

AfterThreadedGenerateData()

template<typename TImage >

void rtk::NesterovUpdateImageFilter< TImage >::AfterThreadedGenerateData ( )

overrideprotected

Does the real work.

BeforeThreadedGenerateData()

template<typename TImage >

void rtk::NesterovUpdateImageFilter< TImage >::BeforeThreadedGenerateData ( )

overrideprotected

Does the real work.

CreateAnother()

template<typename TImage >

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

virtual

Reimplemented from itk::Object.

DynamicThreadedGenerateData()

template<typename TImage >

void rtk::NesterovUpdateImageFilter< TImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

overrideprotected

Does the real work.

GenerateInputRequestedRegion()

template<typename TImage >

void rtk::NesterovUpdateImageFilter< TImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

GetNameOfClass()

template<typename TImage >

const char* rtk::NesterovUpdateImageFilter< TImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

GetNumberOfIterations()

template<typename TImage >

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

virtual

Get and Set macro

New()

template<typename TImage >

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

static

Method for creation through the object factory.

SetNumberOfIterations()

template<typename TImage >

virtual void rtk::NesterovUpdateImageFilter< TImage >::SetNumberOfIterations ( int  _arg )

virtual

Get and Set macro

Member Data Documentation

m_Alphak

template<typename TImage >

TImage::Pointer rtk::NesterovUpdateImageFilter< TImage >::m_Alphak

protected

Definition at line 92 of file rtkNesterovUpdateImageFilter.h.

m_CurrentIteration

template<typename TImage >

int rtk::NesterovUpdateImageFilter< TImage >::m_CurrentIteration

protected

Definition at line 83 of file rtkNesterovUpdateImageFilter.h.

m_MustInitializeIntermediateImages

template<typename TImage >

bool rtk::NesterovUpdateImageFilter< TImage >::m_MustInitializeIntermediateImages

protected

Definition at line 84 of file rtkNesterovUpdateImageFilter.h.

m_NumberOfIterations

template<typename TImage >

int rtk::NesterovUpdateImageFilter< TImage >::m_NumberOfIterations

protected

Definition at line 82 of file rtkNesterovUpdateImageFilter.h.

m_Ratio

template<typename TImage >

TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_Ratio

protected

Definition at line 88 of file rtkNesterovUpdateImageFilter.h.

m_Sum

template<typename TImage >

TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_Sum

protected

Definition at line 87 of file rtkNesterovUpdateImageFilter.h.

m_TCoeff

template<typename TImage >

TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_TCoeff

protected

Definition at line 85 of file rtkNesterovUpdateImageFilter.h.

m_TCoeffNext

template<typename TImage >

TImage::PixelType::ValueType rtk::NesterovUpdateImageFilter< TImage >::m_TCoeffNext

protected

Definition at line 86 of file rtkNesterovUpdateImageFilter.h.

m_Vk

template<typename TImage >

TImage::Pointer rtk::NesterovUpdateImageFilter< TImage >::m_Vk

protected

Definition at line 91 of file rtkNesterovUpdateImageFilter.h.

---

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

• rtkNesterovUpdateImageFilter.h