RTK  2.0.1
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <rtkCyclicDeformationImageFilter.h>

+ Inheritance diagram for rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = itk::SmartPointer< Self >
 
using Self = CyclicDeformationImageFilter
 
using Superclass = itk::ImageToImageFilter< InputImageType, OutputImageType >
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual std::string GetSignalFilename ()
 
virtual void SetSignalFilename (const std::string _arg)
 
virtual void SetSignalVector (std::vector< double > _arg)
 
virtual unsigned int GetFrame ()
 
virtual void SetFrame (unsigned int _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
 CyclicDeformationImageFilter ()
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 
 ~CyclicDeformationImageFilter () override=default
 

Protected Attributes

unsigned int m_FrameInf
 
unsigned int m_FrameSup
 
double m_WeightInf
 
double m_WeightSup
 

Private Attributes

unsigned int m_Frame {0}
 
std::vector< double > m_Signal
 
std::string m_SignalFilename
 

Detailed Description

template<class TInputImage, class TOutputImage>
class rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >

Return 3D deformation vector field according to input 4D vector field, phase signal and frame number.

The 4D deformation vector field (DVF) describes the deformation along one cycle. The phase signal is passed via a file name pointing to a text file with one value per line. It must be in the inteval [0,1), 0 meaning frame 0 of the 4D DVF, 0.5 the middle frame (if the number of frames of the 4D DVF is odd), etc. The frame number is the value of the signal for which we wish to obtain the resulting 3D DVF. Linear interpolation is used to compute that DVF. This cyclic deformation model has been described in [Rit et al, TMI, 2009] and [Rit et al, Med Phys, 2009].

Test:
rtkmotioncompensatedfdktest.cxx
Author
Simon Rit

Definition at line 50 of file rtkCyclicDeformationImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 62 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Definition at line 58 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 63 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 59 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 61 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::Self = CyclicDeformationImageFilter

Standard class type alias.

Definition at line 57 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
using rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::Superclass = itk::ImageToImageFilter<InputImageType, OutputImageType>

Definition at line 60 of file rtkCyclicDeformationImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::CyclicDeformationImageFilter ( )
inlineprotected

Definition at line 85 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::~CyclicDeformationImageFilter ( )
overrideprotecteddefault

Member Function Documentation

template<class TInputImage , class TOutputImage >
void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const
virtual

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual
template<class TInputImage , class TOutputImage >
void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >
virtual unsigned int rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::GetFrame ( )
virtual

Get / Set the frame number. The number is used to lookup in the signal file which phase value should be used to interpolate.

template<class TInputImage , class TOutputImage >
virtual const char* rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage >
virtual std::string rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::GetSignalFilename ( )
virtual

Get / Set the signal file name relating each frame to a phase position. The signal file is a text file containing one line per frame.

template<class TInputImage , class TOutputImage >
static Pointer rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >
virtual void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::SetFrame ( unsigned int  _arg)
virtual

Get / Set the frame number. The number is used to lookup in the signal file which phase value should be used to interpolate.

template<class TInputImage , class TOutputImage >
virtual void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::SetSignalFilename ( const std::string  _arg)
virtual

Get / Set the signal file name relating each frame to a phase position. The signal file is a text file containing one line per frame.

template<class TInputImage , class TOutputImage >
virtual void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::SetSignalVector ( std::vector< double >  _arg)
virtual

Get / Set the signal file name relating each frame to a phase position. The signal file is a text file containing one line per frame.

template<class TInputImage , class TOutputImage >
void rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

template<class TInputImage , class TOutputImage >
unsigned int rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_Frame {0}
private

Definition at line 105 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_FrameInf
protected

Definition at line 99 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_FrameSup
protected

Definition at line 100 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
std::vector<double> rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_Signal
private

Definition at line 108 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
std::string rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_SignalFilename
private

Definition at line 107 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
double rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_WeightInf
protected

Definition at line 101 of file rtkCyclicDeformationImageFilter.h.

template<class TInputImage , class TOutputImage >
double rtk::CyclicDeformationImageFilter< TInputImage, TOutputImage >::m_WeightSup
protected

Definition at line 102 of file rtkCyclicDeformationImageFilter.h.


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