RTK  2.0.1
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::UpsampleImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <rtkUpsampleImageFilter.h>

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

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = itk::SmartPointer< Self >
 
using Self = UpsampleImageFilter
 
using Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetOrder ()
 
virtual TOutputImage::IndexType GetOutputIndex ()
 
virtual TOutputImage::SizeType GetOutputSize ()
 
void SetFactor (unsigned int dimension, unsigned int factor)
 
void SetFactors (unsigned int factors[])
 
virtual void SetOrder (unsigned int _arg)
 
virtual void SetOutputIndex (typename TOutputImage::IndexType _arg)
 
virtual void SetOutputSize (typename TOutputImage::SizeType _arg)
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType) override
 
 UpsampleImageFilter ()
 
 ~UpsampleImageFilter () override=default
 

Private Member Functions

const itk::ImageRegionSplitterBaseGetImageRegionSplitter (void) const override
 

Private Attributes

unsigned int m_Factors [ImageDimension]
 
unsigned int m_Order
 
TOutputImage::IndexType m_OutputIndex
 
TOutputImage::SizeType m_OutputSize
 
itk::ImageRegionSplitterDirection::Pointer m_Splitter
 

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class rtk::UpsampleImageFilter< TInputImage, TOutputImage >

Upsamples an image by the given factor for each dimension.

This filter is inspired from Dan Mueller's GIFT package http://www.insight-journal.org/browse/publication/103

Author
Cyril Mory

Definition at line 39 of file rtkUpsampleImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 49 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 62 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 61 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Definition at line 59 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 60 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 65 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Typedef to images

Definition at line 58 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 48 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::Self = UpsampleImageFilter

Standard class type alias.

Definition at line 46 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
using rtk::UpsampleImageFilter< TInputImage, TOutputImage >::Superclass = itk::ImageToImageFilter<TInputImage,TOutputImage>

Definition at line 47 of file rtkUpsampleImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = TInputImage>
rtk::UpsampleImageFilter< TInputImage, TOutputImage >::UpsampleImageFilter ( )
protected
template<class TInputImage , class TOutputImage = TInputImage>
rtk::UpsampleImageFilter< TInputImage, TOutputImage >::~UpsampleImageFilter ( )
overrideprotecteddefault

Member Function Documentation

template<class TInputImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer rtk::UpsampleImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const
template<class TInputImage , class TOutputImage = TInputImage>
void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
override

UpsampleImageFilter needs a larger input requested region than the output requested region. As such, UpsampleImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also
ProcessObject::GenerateInputRequestedRegion()
template<class TInputImage , class TOutputImage = TInputImage>
void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
override

UpsampleImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image. As such, UpsampleImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also
ProcessObject::GenerateOutputInformaton()
template<class TInputImage , class TOutputImage = TInputImage>
const itk::ImageRegionSplitterBase* rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GetImageRegionSplitter ( void  ) const
overrideprivate
template<class TInputImage , class TOutputImage = TInputImage>
virtual const char* rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>
virtual unsigned int rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GetOrder ( )
virtual
template<class TInputImage , class TOutputImage = TInputImage>
virtual TOutputImage::IndexType rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GetOutputIndex ( )
virtual
template<class TInputImage , class TOutputImage = TInputImage>
virtual TOutputImage::SizeType rtk::UpsampleImageFilter< TInputImage, TOutputImage >::GetOutputSize ( )
virtual
template<class TInputImage , class TOutputImage = TInputImage>
static Pointer rtk::UpsampleImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage = TInputImage>
void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::SetFactor ( unsigned int  dimension,
unsigned int  factor 
)

Sets the shrink factor for the given dimension. All other dimensions are set to 1

template<class TInputImage , class TOutputImage = TInputImage>
void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::SetFactors ( unsigned int  factors[])

Set the shrink factors. Values are clamped to a minimum value of 1.

template<class TInputImage , class TOutputImage = TInputImage>
virtual void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::SetOrder ( unsigned int  _arg)
virtual

Set/Get the order of the wavelet filter This is required because some information about the index of the image is lost during downsampling, and the upsampling filter can't guess what the exact index should be.

template<class TInputImage , class TOutputImage = TInputImage>
virtual void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::SetOutputIndex ( typename TOutputImage::IndexType  _arg)
virtual

Set/Get the index of the output image This is required because some information about the index of the image is lost during downsampling, and the upsampling filter can't guess what the exact index should be. The output index is actually set to OutputIndex + 1.

template<class TInputImage , class TOutputImage = TInputImage>
virtual void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::SetOutputSize ( typename TOutputImage::SizeType  _arg)
virtual

Set/Get the size of the output image This is required because some information about the size of the image is lost during downsampling, and the upsampling filter can't guess what the exact size should be.

template<class TInputImage , class TOutputImage = TInputImage>
void rtk::UpsampleImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType   
)
overrideprotected

UpsampleImageFilter 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 = TInputImage>
const unsigned int rtk::UpsampleImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
static

ImageDimension enumeration.

Definition at line 69 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
unsigned int rtk::UpsampleImageFilter< TInputImage, TOutputImage >::m_Factors[ImageDimension]
private

Definition at line 137 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
unsigned int rtk::UpsampleImageFilter< TInputImage, TOutputImage >::m_Order
private

Definition at line 138 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
TOutputImage::IndexType rtk::UpsampleImageFilter< TInputImage, TOutputImage >::m_OutputIndex
private

Definition at line 140 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
TOutputImage::SizeType rtk::UpsampleImageFilter< TInputImage, TOutputImage >::m_OutputSize
private

Definition at line 139 of file rtkUpsampleImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
itk::ImageRegionSplitterDirection::Pointer rtk::UpsampleImageFilter< TInputImage, TOutputImage >::m_Splitter
private

Definition at line 143 of file rtkUpsampleImageFilter.h.


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