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::ADMMWaveletsConjugateGradientOperator< TOutputImage > Class Template Reference

#include <rtkADMMWaveletsConjugateGradientOperator.h>

+ Inheritance diagram for rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >:
+ Collaboration diagram for rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >:

Public Types

using AddFilterType = itk::AddImageFilter< TOutputImage >
 
using BackProjectionFilterPointer = typename BackProjectionFilterType::Pointer
 
using BackProjectionFilterType = rtk::BackProjectionImageFilter< TOutputImage, TOutputImage >
 
using DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter< TOutputImage >
 
using ForwardProjectionFilterPointer = typename ForwardProjectionFilterType::Pointer
 
using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter< TOutputImage, TOutputImage >
 
using MultiplyFilterType = itk::MultiplyImageFilter< TOutputImage >
 
using Pointer = itk::SmartPointer< Self >
 
using Self = ADMMWaveletsConjugateGradientOperator
 
using Superclass = ConjugateGradientOperator< TOutputImage >
 
- 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
 
virtual bool GetDisableDisplacedDetectorFilter ()
 
virtual const char * GetNameOfClass () const
 
void SetBackProjectionFilter (const BackProjectionFilterPointer _arg)
 
virtual void SetBeta (float _arg)
 
virtual void SetDisableDisplacedDetectorFilter (bool _arg)
 
void SetForwardProjectionFilter (const ForwardProjectionFilterPointer _arg)
 
void SetGeometry (const ThreeDCircularProjectionGeometry::Pointer _arg)
 
- Public Member Functions inherited from rtk::ConjugateGradientOperator< TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
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

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

Protected Attributes

AddFilterType::Pointer m_AddFilter
 
BackProjectionFilterPointer m_BackProjectionFilter
 
float m_Beta
 
bool m_DisableDisplacedDetectorFilter
 
DisplacedDetectorFilterType::Pointer m_DisplacedDetectorFilter
 
ForwardProjectionFilterPointer m_ForwardProjectionFilter
 
MultiplyFilterType::Pointer m_MultiplyFilter
 
MultiplyFilterType::Pointer m_ZeroMultiplyProjectionFilter
 
MultiplyFilterType::Pointer m_ZeroMultiplyVolumeFilter
 

Detailed Description

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

Implements the operator A used in the conjugate gradient step of ADMM reconstruction with wavelets 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 || Rf -p ||_2^2 + alpha * || W(f) ||_1, with R the forward projection operator, p the measured projections, and W the Daubechies wavelets transform. 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 R f + beta * W_t W f. The Daubechies wavelets being orthogonal, W_t happens to be the inverse of W, and therefore the filter outputs R_t R f + beta * f

dot_inline_dotgraph_4.png
Test:
rtkadmmWaveletstest.cxx
Author
Cyril Mory

Definition at line 98 of file rtkADMMWaveletsConjugateGradientOperator.h.

Member Typedef Documentation

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::AddFilterType = itk::AddImageFilter<TOutputImage>

Definition at line 121 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::BackProjectionFilterPointer = typename BackProjectionFilterType::Pointer

Definition at line 115 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::BackProjectionFilterType = rtk::BackProjectionImageFilter< TOutputImage, TOutputImage >

Definition at line 114 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter<TOutputImage>

Definition at line 123 of file rtkADMMWaveletsConjugateGradientOperator.h.

Definition at line 118 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter< TOutputImage, TOutputImage >

Definition at line 117 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::MultiplyFilterType = itk::MultiplyImageFilter<TOutputImage>

Definition at line 120 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::Pointer = itk::SmartPointer< Self >

Definition at line 106 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::Self = ADMMWaveletsConjugateGradientOperator

Standard class type alias.

Definition at line 104 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
using rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::Superclass = ConjugateGradientOperator< TOutputImage >

Definition at line 105 of file rtkADMMWaveletsConjugateGradientOperator.h.

Constructor & Destructor Documentation

template<typename TOutputImage >
rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::ADMMWaveletsConjugateGradientOperator ( )
protected
template<typename TOutputImage >
rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::~ADMMWaveletsConjugateGradientOperator ( )
overrideprotecteddefault

Member Function Documentation

template<typename TOutputImage >
virtual::itk::LightObject::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::CreateAnother ( ) const
template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GenerateData ( )
overrideprotected

Does the real work.

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotected

The volume and the projections must have different requested regions

Referenced by rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::VerifyInputInformation().

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GenerateOutputInformation ( )
overrideprotected

The volume and the projections must have different requested regions

Referenced by rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::VerifyInputInformation().

template<typename TOutputImage >
virtual bool rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GetDisableDisplacedDetectorFilter ( )
virtual
template<typename TOutputImage >
virtual const char* rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from rtk::ConjugateGradientOperator< TOutputImage >.

template<typename TOutputImage >
static Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::SetBackProjectionFilter ( const BackProjectionFilterPointer  _arg)

Set the backprojection filter

template<typename TOutputImage >
virtual void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::SetBeta ( float  _arg)
virtual

Set the regularization parameter

template<typename TOutputImage >
virtual void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::SetDisableDisplacedDetectorFilter ( bool  _arg)
virtual

Set / Get whether the displaced detector filter should be disabled

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::SetForwardProjectionFilter ( const ForwardProjectionFilterPointer  _arg)

Set the forward projection filter

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::SetGeometry ( const ThreeDCircularProjectionGeometry::Pointer  _arg)

Set the geometry of both m_BackProjectionFilter and m_ForwardProjectionFilter

template<typename TOutputImage >
void rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::VerifyInputInformation ( )
inlineoverrideprotected

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

Definition at line 165 of file rtkADMMWaveletsConjugateGradientOperator.h.

References rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GenerateInputRequestedRegion(), and rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::GenerateOutputInformation().

Member Data Documentation

template<typename TOutputImage >
AddFilterType::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_AddFilter
protected

Definition at line 152 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
BackProjectionFilterPointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_BackProjectionFilter
protected

Member pointers to the filters used internally (for convenience)

Definition at line 149 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
float rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_Beta
protected

Definition at line 158 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
bool rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_DisableDisplacedDetectorFilter
protected

Definition at line 159 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
DisplacedDetectorFilterType::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_DisplacedDetectorFilter
protected

Definition at line 156 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
ForwardProjectionFilterPointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_ForwardProjectionFilter
protected

Definition at line 150 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
MultiplyFilterType::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_MultiplyFilter
protected

Definition at line 153 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
MultiplyFilterType::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_ZeroMultiplyProjectionFilter
protected

Definition at line 154 of file rtkADMMWaveletsConjugateGradientOperator.h.

template<typename TOutputImage >
MultiplyFilterType::Pointer rtk::ADMMWaveletsConjugateGradientOperator< TOutputImage >::m_ZeroMultiplyVolumeFilter
protected

Definition at line 155 of file rtkADMMWaveletsConjugateGradientOperator.h.


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