rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage > Class Template Reference

#include <rtkADMMTotalVariationConjugateGradientOperator.h>

Inheritance diagram for rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >:

Collaboration diagram for rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >:

Public Types
using	BackProjectionFilterPointer = typename BackProjectionFilterType::Pointer
using	BackProjectionFilterType = rtk::BackProjectionImageFilter< TOutputImage, TOutputImage >
using	CPUImageType = itk::Image< typename TOutputImage::PixelType, TOutputImage::ImageDimension >
using	DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter< TOutputImage >
using	DivergenceFilterType = rtk::BackwardDifferenceDivergenceImageFilter< GradientImageType, TOutputImage >
using	ForwardProjectionFilterPointer = typename ForwardProjectionFilterType::Pointer
using	ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter< TOutputImage, TOutputImage >
using	GatingWeightsFilterType = rtk::MultiplyByVectorImageFilter< TOutputImage >
using	GradientFilterType = ForwardDifferenceGradientImageFilter< TOutputImage, typename TOutputImage::ValueType, typename TOutputImage::ValueType, GradientImageType >
typedef std::conditional< std::is_same< TOutputImage, CPUImageType >::value, itk::Image< VectorPixelType, TOutputImage::ImageDimension >, itk::CudaImage< VectorPixelType, TOutputImage::ImageDimension > >::type	GradientImageType
using	MultiplyFilterType = itk::MultiplyImageFilter< TOutputImage >
using	Pointer = itk::SmartPointer< Self >
using	Self = ADMMTotalVariationConjugateGradientOperator
using	SubtractFilterType = itk::SubtractImageFilter< TOutputImage >
using	Superclass = ConjugateGradientOperator< TOutputImage >
using	VectorPixelType = itk::CovariantVector< typename TOutputImage::ValueType, TOutputImage::ImageDimension >
Public Types inherited from rtk::ConjugateGradientOperator< TOutputImage >
using	Pointer = itk::SmartPointer< Self >
using	Self = ConjugateGradientOperator
using	Superclass = itk::ImageToImageFilter< TOutputImage, TOutputImage >

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
const char *	GetNameOfClass () const override
void	SetBackProjectionFilter (BackProjectionFilterType *_arg)
virtual void	SetBeta (float _arg)
void	SetForwardProjectionFilter (ForwardProjectionFilterType *_arg)
void	SetGatingWeights (std::vector< float > weights)
virtual void	SetGeometry (ThreeDCircularProjectionGeometry *_arg)
virtual void	SetDisableDisplacedDetectorFilter (bool _arg)
virtual bool	GetDisableDisplacedDetectorFilter ()
Public Member Functions inherited from rtk::ConjugateGradientOperator< TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother () const
const char *	GetNameOfClass () const override
virtual void	SetX (const TOutputImage *OutputImage)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from rtk::ConjugateGradientOperator< TOutputImage >
static Pointer	New ()

Protected Member Functions
	ADMMTotalVariationConjugateGradientOperator ()
void	GenerateData () override
void	VerifyInputInformation () const override
void	VerifyPreconditions () const override
	~ADMMTotalVariationConjugateGradientOperator () override=default
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
Protected Member Functions inherited from rtk::ConjugateGradientOperator< TOutputImage >
	ConjugateGradientOperator ()
	~ConjugateGradientOperator () override=default

Protected Attributes
BackProjectionFilterPointer	m_BackProjectionFilter
float	m_Beta
bool	m_DisableDisplacedDetectorFilter
DisplacedDetectorFilterType::Pointer	m_DisplacedDetectorFilter
DivergenceFilterType::Pointer	m_DivergenceFilter
ForwardProjectionFilterPointer	m_ForwardProjectionFilter
std::vector< float >	m_GatingWeights
GatingWeightsFilterType::Pointer	m_GatingWeightsFilter
ThreeDCircularProjectionGeometry::Pointer	m_Geometry
GradientFilterType::Pointer	m_GradientFilter
bool	m_IsGated
MultiplyFilterType::Pointer	m_MultiplyFilter
SubtractFilterType::Pointer	m_SubtractFilter
MultiplyFilterType::Pointer	m_ZeroMultiplyProjectionFilter
MultiplyFilterType::Pointer	m_ZeroMultiplyVolumeFilter

Detailed Description

template<typename TOutputImage>
class rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >

Implements the operator A used in the conjugate gradient step of ADMM reconstruction with total variation regularization.

This filter implements the operator A used in the conjugate gradient step of a reconstruction method based on compressed sensing. The method attempts to find the f that minimizes || sqrt(D) (Rf -p) ||_2^2 + alpha * TV(f), with R the forward projection operator, p the measured projections, D the displaced detector weighting matrix, and TV the total variation. Details on the method and the calculations can be found in

Mory, C., B. Zhang, V. Auvray, M. Grass, D. Schafer, F. Peyrin, S. Rit, P. Douek, and L. Boussel. "ECG-Gated C-Arm Computed Tomography Using L1 Regularization." In Proceedings of the 20th European Signal Processing Conference (EUSIPCO), 2728-32, 2012.

This filter takes in input f and outputs R_t D R f - beta div(grad(f)).

Test:

rtkadmmtotalvariationtest.cxx

Author

Cyril Mory

Definition at line 108 of file rtkADMMTotalVariationConjugateGradientOperator.h.

Member Typedef Documentation

BackProjectionFilterPointer

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::BackProjectionFilterPointer = typename BackProjectionFilterType::Pointer

Definition at line 125 of file rtkADMMTotalVariationConjugateGradientOperator.h.

BackProjectionFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::BackProjectionFilterType = rtk::BackProjectionImageFilter<TOutputImage, TOutputImage>

Definition at line 124 of file rtkADMMTotalVariationConjugateGradientOperator.h.

CPUImageType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::CPUImageType = itk::Image<typename TOutputImage::PixelType, TOutputImage::ImageDimension>

Definition at line 134 of file rtkADMMTotalVariationConjugateGradientOperator.h.

DisplacedDetectorFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter<TOutputImage>

Definition at line 149 of file rtkADMMTotalVariationConjugateGradientOperator.h.

DivergenceFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::DivergenceFilterType = rtk::BackwardDifferenceDivergenceImageFilter<GradientImageType, TOutputImage>

Definition at line 148 of file rtkADMMTotalVariationConjugateGradientOperator.h.

ForwardProjectionFilterPointer

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::ForwardProjectionFilterPointer = typename ForwardProjectionFilterType::Pointer

Definition at line 128 of file rtkADMMTotalVariationConjugateGradientOperator.h.

ForwardProjectionFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<TOutputImage, TOutputImage>

Definition at line 127 of file rtkADMMTotalVariationConjugateGradientOperator.h.

GatingWeightsFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GatingWeightsFilterType = rtk::MultiplyByVectorImageFilter<TOutputImage>

Definition at line 150 of file rtkADMMTotalVariationConjugateGradientOperator.h.

GradientFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GradientFilterType = ForwardDifferenceGradientImageFilter<TOutputImage, typename TOutputImage::ValueType, typename TOutputImage::ValueType, GradientImageType>

Definition at line 147 of file rtkADMMTotalVariationConjugateGradientOperator.h.

GradientImageType

template<typename TOutputImage >

typedef std::conditional<std::is_same<TOutputImage, CPUImageType>::value, itk::Image<VectorPixelType, TOutputImage::ImageDimension>, itk::CudaImage<VectorPixelType, TOutputImage::ImageDimension> >::type rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GradientImageType

Definition at line 139 of file rtkADMMTotalVariationConjugateGradientOperator.h.

MultiplyFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::MultiplyFilterType = itk::MultiplyImageFilter<TOutputImage>

Definition at line 130 of file rtkADMMTotalVariationConjugateGradientOperator.h.

Pointer

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 116 of file rtkADMMTotalVariationConjugateGradientOperator.h.

Self

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::Self = ADMMTotalVariationConjugateGradientOperator

Standard class type alias.

Definition at line 114 of file rtkADMMTotalVariationConjugateGradientOperator.h.

SubtractFilterType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SubtractFilterType = itk::SubtractImageFilter<TOutputImage>

Definition at line 131 of file rtkADMMTotalVariationConjugateGradientOperator.h.

Superclass

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::Superclass = ConjugateGradientOperator<TOutputImage>

Definition at line 115 of file rtkADMMTotalVariationConjugateGradientOperator.h.

VectorPixelType

template<typename TOutputImage >

using rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::VectorPixelType = itk::CovariantVector<typename TOutputImage::ValueType, TOutputImage::ImageDimension>

Definition at line 133 of file rtkADMMTotalVariationConjugateGradientOperator.h.

Constructor & Destructor Documentation

ADMMTotalVariationConjugateGradientOperator()

template<typename TOutputImage >

rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::ADMMTotalVariationConjugateGradientOperator ( )

protected

~ADMMTotalVariationConjugateGradientOperator()

template<typename TOutputImage >

rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::~ADMMTotalVariationConjugateGradientOperator ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TOutputImage >

virtual::itk::LightObject::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

GenerateData()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

GenerateInputRequestedRegion()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

The volume and the projections must have different requested regions

Reimplemented from itk::ProcessObject.

GenerateOutputInformation()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

The volume and the projections must have different requested regions

Reimplemented from itk::ProcessObject.

GetDisableDisplacedDetectorFilter()

template<typename TOutputImage >

virtual bool rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GetDisableDisplacedDetectorFilter ( )

virtual

Set / Get whether the displaced detector filter should be disabled

GetNameOfClass()

template<typename TOutputImage >

const char* rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

New()

template<typename TOutputImage >

static Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::New ( )

static

Method for creation through the object factory.

SetBackProjectionFilter()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetBackProjectionFilter

(

BackProjectionFilterType *

_arg

)

Set the backprojection filter

SetBeta()

template<typename TOutputImage >

virtual void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetBeta ( float  _arg )

virtual

Set the regularization parameter

SetDisableDisplacedDetectorFilter()

template<typename TOutputImage >

virtual void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetDisableDisplacedDetectorFilter ( bool  _arg )

virtual

Set / Get whether the displaced detector filter should be disabled

SetForwardProjectionFilter()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetForwardProjectionFilter

(

ForwardProjectionFilterType *

_arg

)

Set the forward projection filter

SetGatingWeights()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetGatingWeights

(

std::vector< float >

weights

)

In the case of a gated reconstruction, set the gating weights

SetGeometry()

template<typename TOutputImage >

virtual void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::SetGeometry ( ThreeDCircularProjectionGeometry *  _arg )

virtual

Pass the geometry to all filters needing it

VerifyInputInformation()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::VerifyInputInformation ( ) const

inlineoverrideprotectedvirtual

When the inputs have the same type, ITK checks whether they occupy the same physical space or not. Obviously they dont, so we have to remove this check

Reimplemented from itk::ProcessObject.

Definition at line 213 of file rtkADMMTotalVariationConjugateGradientOperator.h.

VerifyPreconditions()

template<typename TOutputImage >

void rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::VerifyPreconditions ( ) const

overrideprotectedvirtual

Checks that inputs are correctly set.

Reimplemented from itk::ProcessObject.

Member Data Documentation

m_BackProjectionFilter

template<typename TOutputImage >

BackProjectionFilterPointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_BackProjectionFilter

protected

Member pointers to the filters used internally (for convenience)

Definition at line 188 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_Beta

template<typename TOutputImage >

float rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_Beta

protected

Definition at line 201 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_DisableDisplacedDetectorFilter

template<typename TOutputImage >

bool rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_DisableDisplacedDetectorFilter

protected

Definition at line 202 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_DisplacedDetectorFilter

template<typename TOutputImage >

DisplacedDetectorFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_DisplacedDetectorFilter

protected

Definition at line 197 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_DivergenceFilter

template<typename TOutputImage >

DivergenceFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_DivergenceFilter

protected

Definition at line 195 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_ForwardProjectionFilter

template<typename TOutputImage >

ForwardProjectionFilterPointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_ForwardProjectionFilter

protected

Definition at line 189 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_GatingWeights

template<typename TOutputImage >

std::vector<float> rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_GatingWeights

protected

Definition at line 207 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_GatingWeightsFilter

template<typename TOutputImage >

GatingWeightsFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_GatingWeightsFilter

protected

Definition at line 198 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_Geometry

template<typename TOutputImage >

ThreeDCircularProjectionGeometry::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_Geometry

protected

Definition at line 200 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_GradientFilter

template<typename TOutputImage >

GradientFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_GradientFilter

protected

Definition at line 196 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_IsGated

template<typename TOutputImage >

bool rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_IsGated

protected

Have gating weights been set ? If so, apply them, otherwise ignore the gating weights filter

Definition at line 206 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_MultiplyFilter

template<typename TOutputImage >

MultiplyFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_MultiplyFilter

protected

Definition at line 192 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_SubtractFilter

template<typename TOutputImage >

SubtractFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_SubtractFilter

protected

Definition at line 191 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_ZeroMultiplyProjectionFilter

template<typename TOutputImage >

MultiplyFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_ZeroMultiplyProjectionFilter

protected

Definition at line 193 of file rtkADMMTotalVariationConjugateGradientOperator.h.

m_ZeroMultiplyVolumeFilter

template<typename TOutputImage >

MultiplyFilterType::Pointer rtk::ADMMTotalVariationConjugateGradientOperator< TOutputImage >::m_ZeroMultiplyVolumeFilter

protected

Definition at line 194 of file rtkADMMTotalVariationConjugateGradientOperator.h.

---

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

• rtkADMMTotalVariationConjugateGradientOperator.h