RTK  2.0.1
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected 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

using ConstPointer = itk::SmartPointer< const Self >
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = itk::SmartPointer< Self >
 
using RealType = TRealType
 
using RealVectorImageType = itk::Image< RealVectorType, TInputImage::ImageDimension >
 
using RealVectorType = itk::Vector< TRealType, InputPixelType::Dimension >
 
using Self = SoftThresholdTVImageFilter
 
using Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >
 

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 ()
 
 ~SoftThresholdTVImageFilter () override=default
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 

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>
using rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::ConstPointer = itk::SmartPointer< const Self >

Definition at line 57 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 73 of file rtkSoftThresholdTVImageFilter.h.

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

Image type alias support

Definition at line 71 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 68 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 74 of file rtkSoftThresholdTVImageFilter.h.

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

Superclass type alias.

Definition at line 90 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 72 of file rtkSoftThresholdTVImageFilter.h.

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

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

Definition at line 67 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 56 of file rtkSoftThresholdTVImageFilter.h.

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

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

Definition at line 85 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 87 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 86 of file rtkSoftThresholdTVImageFilter.h.

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

Standard class type alias.

Definition at line 54 of file rtkSoftThresholdTVImageFilter.h.

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

Definition at line 55 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>
rtk::SoftThresholdTVImageFilter< TInputImage, TRealType, TOutputImage >::~SoftThresholdTVImageFilter ( )
overrideprotecteddefault

Member Function Documentation

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

Reimplemented from itk::Object.

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::ImageToImageFilter< TInputImage, 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>
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 
)
overrideprotectedvirtual

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()

Reimplemented from itk::ImageSource< TOutputImage >.

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 78 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 137 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 136 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 82 of file rtkSoftThresholdTVImageFilter.h.


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