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

#include <rtkMagnitudeThresholdImageFilter.h>

+ Inheritance diagram for rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >:
+ Collaboration diagram for rtk::MagnitudeThresholdImageFilter< 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 = MagnitudeThresholdImageFilter
 
using Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >
 

Public Member Functions

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

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
 
 MagnitudeThresholdImageFilter ()
 
 ~MagnitudeThresholdImageFilter () override=default
 

Private Attributes

TRealType m_Threshold
 

Detailed Description

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

Performs thresholding on the norm of each vector-valued input pixel.

If the norm of a vector is higher than the threshold, divides the components of the vector by norm / threshold. Mathematically, it amounts to projecting onto the L_2 ball of radius m_Threshold

Author
Cyril Mory

Definition at line 40 of file rtkMagnitudeThresholdImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file rtkMagnitudeThresholdImageFilter.h.

◆ InputImagePointer

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

Definition at line 70 of file rtkMagnitudeThresholdImageFilter.h.

◆ InputImageType

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

Image type alias support

Definition at line 68 of file rtkMagnitudeThresholdImageFilter.h.

◆ InputPixelType

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

Definition at line 65 of file rtkMagnitudeThresholdImageFilter.h.

◆ OutputImagePointer

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

Definition at line 71 of file rtkMagnitudeThresholdImageFilter.h.

◆ OutputImageRegionType

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

Superclass type alias.

Definition at line 85 of file rtkMagnitudeThresholdImageFilter.h.

◆ OutputImageType

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

Definition at line 69 of file rtkMagnitudeThresholdImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
using rtk::MagnitudeThresholdImageFilter< 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 64 of file rtkMagnitudeThresholdImageFilter.h.

◆ Pointer

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

Definition at line 48 of file rtkMagnitudeThresholdImageFilter.h.

◆ RealType

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

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

Definition at line 80 of file rtkMagnitudeThresholdImageFilter.h.

◆ RealVectorImageType

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

Definition at line 82 of file rtkMagnitudeThresholdImageFilter.h.

◆ RealVectorType

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

Definition at line 81 of file rtkMagnitudeThresholdImageFilter.h.

◆ Self

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

Standard class type alias.

Definition at line 46 of file rtkMagnitudeThresholdImageFilter.h.

◆ Superclass

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

Definition at line 47 of file rtkMagnitudeThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ MagnitudeThresholdImageFilter()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::MagnitudeThresholdImageFilter ( )
protected

◆ ~MagnitudeThresholdImageFilter()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::~MagnitudeThresholdImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

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

Reimplemented from itk::Object.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
void rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread)
overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetNameOfClass()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual const char* rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

◆ GetThreshold()

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

Begin concept checking End concept checking

◆ New()

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

Method for creation through the object factory.

◆ SetThreshold()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
virtual void rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::SetThreshold ( TRealType  _arg)
virtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TRealType = float, typename TOutputImage = TInputImage>
constexpr unsigned int rtk::MagnitudeThresholdImageFilter< TInputImage, TRealType, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

The dimensionality of the input and output images.

Definition at line 74 of file rtkMagnitudeThresholdImageFilter.h.

◆ m_Threshold

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

Definition at line 106 of file rtkMagnitudeThresholdImageFilter.h.

◆ VectorDimension

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

Length of the vector pixel type of the input image.

Definition at line 77 of file rtkMagnitudeThresholdImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Thu Apr 25 2024 06:23:36 for RTK by   doxygen 1.8.14