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

#include <rtkSoftThresholdTVImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef TInputImage::PixelType InputPixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TRealType RealType
 
typedef itk::Image< RealVectorType, TInputImage::ImageDimension > RealVectorImageType
 
typedef itk::Vector< TRealType, InputPixelType::DimensionRealVectorType
 
typedef SoftThresholdTVImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual float GetThreshold ()
 
virtual void SetThreshold (float _arg)
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
 
static const unsigned int VectorDimension = InputPixelType::Dimension
 

Protected Member Functions

 SoftThresholdTVImageFilter ()
 
virtual ~SoftThresholdTVImageFilter () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 

Private Member Functions

void operator= (const Self &)
 
 SoftThresholdTVImageFilter (const Self &)
 

Private Attributes

ThreadIdType m_RequestedNumberOfThreads
 
float m_Threshold
 

Detailed Description

template<typename TInputImage, typename TRealType = float, typename TOutputImage = TInputImage>
class rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >

Computes the Total Variation from a gradient input image (pixels are vectors), soft thresholds it, and outputs a multiple channel image with vectors colinear to the input vectors but having a smaller norm.

Author
Cyril Mory

Definition at line 47 of file rtkSoftThresholdTVImageFilter.h.

Member Typedef Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef itk::SmartPointer< const Self > rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::ConstPointer

Definition at line 55 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef InputImageType::Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::InputImagePointer

Definition at line 71 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef TInputImage rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::InputImageType

Image typedef support

Definition at line 69 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef TInputImage::PixelType rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::InputPixelType

Definition at line 66 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef OutputImageType::Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::OutputImagePointer

Definition at line 72 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef Superclass::OutputImageRegionType rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Definition at line 88 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef TOutputImage rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageType

Definition at line 70 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef TOutputImage::PixelType rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 61 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef itk::SmartPointer< Self > rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::Pointer

Definition at line 54 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef TRealType rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::RealType

Define the data type and the vector of data type used in calculations.

Definition at line 83 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef itk::Image< RealVectorType, TInputImage::ImageDimension > rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorImageType

Definition at line 85 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef itk::Vector< TRealType, InputPixelType::Dimension > rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorType

Definition at line 84 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef SoftThresholdTVImageFilter rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::Self

Standard class typedefs.

Definition at line 52 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::Superclass

Definition at line 53 of file rtkSoftThresholdTVImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::SoftThresholdTVImageFilter ( )
protected
template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::~SoftThresholdTVImageFilter ( )
inlineoverrideprotectedvirtual

Definition at line 105 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::SoftThresholdTVImageFilter ( const Self )
private

Member Function Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::CreateAnother ( ) const
template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual const char* rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual float rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::GetThreshold ( )
virtual

Begin concept checking End concept checking

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
static Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
void rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::operator= ( const Self )
private
template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual void rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::SetThreshold ( float  _arg)
virtual
template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
void rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotected

Do any necessary casting/copying of the input data. Input pixel types whose value types are not real number types must be cast to real number types. SoftThresholdTVImageFilter 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<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
const unsigned int rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

The dimensionality of the input and output images.

Definition at line 76 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
ThreadIdType rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::m_RequestedNumberOfThreads
private

Definition at line 135 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
float rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::m_Threshold
private

Definition at line 134 of file rtkSoftThresholdTVImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
const unsigned int rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::VectorDimension = InputPixelType::Dimension
static

Length of the vector pixel type of the input image.

Definition at line 80 of file rtkSoftThresholdTVImageFilter.h.


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