Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage > Class Template Reference

Applies a total variation denoising filter to an image. More...

#include <itkTotalVariationSingleIterationImageFilter.h>

Inheritance diagram for itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >:
Collaboration graph
[legend]

Public Types

typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef itk::Image< float, InputImageDimension > LocalVariationImageType
 
typedef TotalVariationSingleIterationImageFilter Self
 
typedef ImageToImageFilter< InputImageType, OutputImageType > Superclass
 
typedef SmartPointer< Self > Pointer
 
typedef SmartPointer< const Self > ConstPointer
 
typedef InputImageType::PixelType InputPixelType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef InputImageType::SizeType InputSizeType
 

Public Member Functions

 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
 
Pointer Clone () const
 
virtual const char * GetClassName () const
 
virtual void GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
 
virtual void SetLambda (double _arg)
 
virtual double GetLambda ()
 
void SetOriginalImage (InputImageType *in)
 
InputImageType::Pointer GetOriginialImage ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 TotalVariationSingleIterationImageFilter ()
 
virtual ~TotalVariationSingleIterationImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
void BeforeThreadedGenerateData ()
 

Protected Attributes

LocalVariationImageType::Pointer m_LocalVariation
 
InputImageType::Pointer m_OriginalImage
 
double m_Lambda
 

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >

Applies a total variation denoising filter to an image.

Reference: Tony F. Chan et al., The digital TV filter and nonlinear denoising

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator

Definition at line 38 of file itkTotalVariationSingleIterationImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer<const Self> itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 55 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 67 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::InputImageType

Convenient typedefs for simplifying declarations.

Definition at line 46 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::InputPixelType

Image typedef support.

Definition at line 61 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 70 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::Image<float, InputImageDimension> itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::LocalVariationImageType

Definition at line 49 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 68 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 47 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 65 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer<Self> itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 54 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TotalVariationSingleIterationImageFilter itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 52 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter<InputImageType, OutputImageType> itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 53 of file itkTotalVariationSingleIterationImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::TotalVariationSingleIterationImageFilter ( )
protected
template<class TInputImage , class TOutputImage >
virtual itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::~TotalVariationSingleIterationImageFilter ( )
inlineprotectedvirtual

Definition at line 87 of file itkTotalVariationSingleIterationImageFilter.h.

Member Function Documentation

template<class TInputImage , class TOutputImage >
void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
protected
template<class TInputImage , class TOutputImage >
Pointer itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::Clone ( ) const
template<class TInputImage , class TOutputImage >
virtual void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
throw (InvalidRequestedRegionError
)
virtual

A larger input requested region than the output requested region is required. Therefore, an implementation for GenerateInputRequestedRegion() is provided.

See also
ImageToImageFilter::GenerateInputRequestedRegion()
template<class TInputImage , class TOutputImage >
virtual const char* itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

template<class TInputImage , class TOutputImage >
virtual double itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::GetLambda ( )
virtual
template<class TInputImage , class TOutputImage >
InputImageType::Pointer itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::GetOriginialImage ( )
inline

Definition at line 84 of file itkTotalVariationSingleIterationImageFilter.h.

References itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::m_OriginalImage.

template<class TInputImage , class TOutputImage >
itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
TInputImage::ImageDimension   
)

Extract dimension from input and output image.

template<class TInputImage , class TOutputImage >
itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension  ,
unsigned  int,
TOutputImage::ImageDimension   
)
template<class TInputImage , class TOutputImage >
static Pointer itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >
void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protected
template<class TInputImage , class TOutputImage >
virtual void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::SetLambda ( double  _arg)
virtual
template<class TInputImage , class TOutputImage >
void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::SetOriginalImage ( InputImageType *  in)
inline

Definition at line 83 of file itkTotalVariationSingleIterationImageFilter.h.

References Json::in(), and itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::m_OriginalImage.

template<class TInputImage , class TOutputImage >
void itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  threadId 
)
protected

MedianImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Member Data Documentation

template<class TInputImage , class TOutputImage >
double itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::m_Lambda
protected

Definition at line 108 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
LocalVariationImageType::Pointer itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::m_LocalVariation
protected

Definition at line 104 of file itkTotalVariationSingleIterationImageFilter.h.

template<class TInputImage , class TOutputImage >
InputImageType::Pointer itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::m_OriginalImage
protected

Definition at line 106 of file itkTotalVariationSingleIterationImageFilter.h.

Referenced by itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::GetOriginialImage(), and itk::TotalVariationSingleIterationImageFilter< TInputImage, TOutputImage >::SetOriginalImage().

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