rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <rtkSoftThresholdTVImageFilter.h>

Inheritance diagram for rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for rtk::SoftThresholdTVImageFilter< TInputImage, 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	Self = SoftThresholdTVImageFilter
using	Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >

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

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension
static constexpr unsigned int	VectorDimension = InputPixelType::Dimension

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
	SoftThresholdTVImageFilter ()
	~SoftThresholdTVImageFilter () override=default

Private Attributes
ThreadIdType	m_RequestedNumberOfThreads
float	m_Threshold

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class rtk::SoftThresholdTVImageFilter< TInputImage, 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 45 of file rtkSoftThresholdTVImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 54 of file rtkSoftThresholdTVImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 70 of file rtkSoftThresholdTVImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type alias support

Definition at line 68 of file rtkSoftThresholdTVImageFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 65 of file rtkSoftThresholdTVImageFilter.h.

OutputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 71 of file rtkSoftThresholdTVImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Superclass type alias.

Definition at line 80 of file rtkSoftThresholdTVImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 69 of file rtkSoftThresholdTVImageFilter.h.

OutputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, 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 64 of file rtkSoftThresholdTVImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 53 of file rtkSoftThresholdTVImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::Self = SoftThresholdTVImageFilter

Standard class type alias.

Definition at line 51 of file rtkSoftThresholdTVImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage = TInputImage>

using rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 52 of file rtkSoftThresholdTVImageFilter.h.

Constructor & Destructor Documentation

SoftThresholdTVImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>

rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::SoftThresholdTVImageFilter ( )

protected

~SoftThresholdTVImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>

rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::~SoftThresholdTVImageFilter ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual::itk::LightObject::Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>

void rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

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< typename TOutputImage >.

GetNameOfClass()

template<typename TInputImage , typename TOutputImage = TInputImage>

const char* rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods)

Reimplemented from itk::ImageSource< typename TOutputImage >.

GetThreshold()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual float rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::GetThreshold ( )

virtual

Begin concept checking End concept checking

New()

template<typename TInputImage , typename TOutputImage = TInputImage>

static Pointer rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

SetThreshold()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::SetThreshold ( float  _arg )

virtual

Member Data Documentation

ImageDimension

template<typename TInputImage , typename TOutputImage = TInputImage>

constexpr unsigned int rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

static

The dimensionality of the input and output images.

Definition at line 74 of file rtkSoftThresholdTVImageFilter.h.

m_RequestedNumberOfThreads

template<typename TInputImage , typename TOutputImage = TInputImage>

ThreadIdType rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::m_RequestedNumberOfThreads

private

Definition at line 117 of file rtkSoftThresholdTVImageFilter.h.

m_Threshold

template<typename TInputImage , typename TOutputImage = TInputImage>

float rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::m_Threshold

private

Definition at line 116 of file rtkSoftThresholdTVImageFilter.h.

VectorDimension

template<typename TInputImage , typename TOutputImage = TInputImage>

constexpr unsigned int rtk::SoftThresholdTVImageFilter< TInputImage, TOutputImage >::VectorDimension = InputPixelType::Dimension

static

Length of the vector pixel type of the input image.

Definition at line 77 of file rtkSoftThresholdTVImageFilter.h.

---

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

• rtkSoftThresholdTVImageFilter.h