rtk::ConjugateGradientImageFilter< OutputImageType > Class Template Reference

#include <rtkConjugateGradientImageFilter.h>

Inheritance diagram for rtk::ConjugateGradientImageFilter< OutputImageType >:

Collaboration diagram for rtk::ConjugateGradientImageFilter< OutputImageType >:

Public Types
using	ConjugateGradientOperatorType = ConjugateGradientOperator< OutputImageType >
using	OutputImagePointer = typename OutputImageType::Pointer
using	Pointer = itk::SmartPointer< Self >
using	Self = ConjugateGradientImageFilter
using	Superclass = itk::InPlaceImageFilter< OutputImageType, OutputImageType >

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	SetA (ConjugateGradientOperatorType *_arg)
void	SetB (const OutputImageType *OutputImage)
void	SetX (const OutputImageType *OutputImage)
virtual const char *	GetNameOfClass () const
virtual int	GetNumberOfIterations ()
virtual void	SetNumberOfIterations (int _arg)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ConjugateGradientImageFilter ()
void	GenerateData () override
OutputImagePointer	GetB ()
OutputImagePointer	GetX ()
	~ConjugateGradientImageFilter () override=default
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override

Protected Attributes
ConjugateGradientOperatorType *	m_A
int	m_NumberOfIterations

Detailed Description

template<typename OutputImageType>
class rtk::ConjugateGradientImageFilter< OutputImageType >

Solves AX = B by conjugate gradient.

ConjugateGradientImageFilter implements the algorithm described in https://en.wikipedia.org/wiki/Conjugate_gradient_method

Definition at line 46 of file rtkConjugateGradientImageFilter.h.

Member Typedef Documentation

ConjugateGradientOperatorType

template<typename OutputImageType >

using rtk::ConjugateGradientImageFilter< OutputImageType >::ConjugateGradientOperatorType = ConjugateGradientOperator<OutputImageType>

Definition at line 56 of file rtkConjugateGradientImageFilter.h.

OutputImagePointer

template<typename OutputImageType >

using rtk::ConjugateGradientImageFilter< OutputImageType >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 57 of file rtkConjugateGradientImageFilter.h.

Pointer

template<typename OutputImageType >

using rtk::ConjugateGradientImageFilter< OutputImageType >::Pointer = itk::SmartPointer<Self>

Definition at line 55 of file rtkConjugateGradientImageFilter.h.

Self

template<typename OutputImageType >

using rtk::ConjugateGradientImageFilter< OutputImageType >::Self = ConjugateGradientImageFilter

Standard class type alias.

Definition at line 53 of file rtkConjugateGradientImageFilter.h.

Superclass

template<typename OutputImageType >

using rtk::ConjugateGradientImageFilter< OutputImageType >::Superclass = itk::InPlaceImageFilter<OutputImageType, OutputImageType>

Definition at line 54 of file rtkConjugateGradientImageFilter.h.

Constructor & Destructor Documentation

ConjugateGradientImageFilter()

template<typename OutputImageType >

rtk::ConjugateGradientImageFilter< OutputImageType >::ConjugateGradientImageFilter ( )

protected

~ConjugateGradientImageFilter()

template<typename OutputImageType >

rtk::ConjugateGradientImageFilter< OutputImageType >::~ConjugateGradientImageFilter ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename OutputImageType >

virtual::itk::LightObject::Pointer rtk::ConjugateGradientImageFilter< OutputImageType >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

GenerateData()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::GenerateData ( )

overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateInputRequestedRegion()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

Conjugate gradient requires the whole image

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

GenerateOutputInformation()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::GenerateOutputInformation ( )

overrideprotectedvirtual

Conjugate gradient requires the whole image

Reimplemented from itk::ProcessObject.

GetB()

template<typename OutputImageType >

OutputImagePointer rtk::ConjugateGradientImageFilter< OutputImageType >::GetB ( )

protected

GetNameOfClass()

template<typename OutputImageType >

virtual const char* rtk::ConjugateGradientImageFilter< OutputImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

GetNumberOfIterations()

template<typename OutputImageType >

virtual int rtk::ConjugateGradientImageFilter< OutputImageType >::GetNumberOfIterations ( )

virtual

Get and Set macro

GetX()

template<typename OutputImageType >

OutputImagePointer rtk::ConjugateGradientImageFilter< OutputImageType >::GetX ( )

protected

New()

template<typename OutputImageType >

static Pointer rtk::ConjugateGradientImageFilter< OutputImageType >::New ( )

static

Method for creation through the object factory.

SetA()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::SetA

(

ConjugateGradientOperatorType *

_arg

)

SetB()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::SetB

(

const OutputImageType *

OutputImage

)

The image called "B" in the CG algorithm.

SetNumberOfIterations()

template<typename OutputImageType >

virtual void rtk::ConjugateGradientImageFilter< OutputImageType >::SetNumberOfIterations ( int  _arg )

virtual

Get and Set macro

SetX()

template<typename OutputImageType >

void rtk::ConjugateGradientImageFilter< OutputImageType >::SetX

(

const OutputImageType *

OutputImage

)

The input image to be updated.

Member Data Documentation

m_A

template<typename OutputImageType >

ConjugateGradientOperatorType* rtk::ConjugateGradientImageFilter< OutputImageType >::m_A

protected

Definition at line 106 of file rtkConjugateGradientImageFilter.h.

m_NumberOfIterations

template<typename OutputImageType >

int rtk::ConjugateGradientImageFilter< OutputImageType >::m_NumberOfIterations

protected

Definition at line 108 of file rtkConjugateGradientImageFilter.h.

---

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

• rtkConjugateGradientImageFilter.h