Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::ToFImageDownsamplingFilter Class Reference

Reduces the resolution of a ToF distance image. Although it is meant to be used for ToF distance images, it should work for any 2D or 3D images. The dimensions (in pixels) of the desired image are taken as input parameters, and an image with these specified dimensions is created. More...

#include <mitkToFImageDownsamplingFilter.h>

Inheritance diagram for mitk::ToFImageDownsamplingFilter:
Collaboration diagram for mitk::ToFImageDownsamplingFilter:

Public Member Functions

 mitkClassMacro (ToFImageDownsamplingFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetResampledX (double _arg)
 
virtual double GetResampledX ()
 
virtual void SetResampledY (double _arg)
 
virtual double GetResampledY ()
 
virtual void SetResampledZ (double _arg)
 
virtual double GetResampledZ ()
 
- Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const InputImageType *image)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ToFImageDownsamplingFilter ()
 Standard constructor. More...
 
 ~ToFImageDownsamplingFilter () override
 Standard destructor. More...
 
void GenerateData () override
 Method generating the output of this filter. Called in the updated process of the pipeline. This method calls the AccessFixedDimensionByItk class with the ItkImageResampling function below. More...
 
template<typename TPixel , unsigned int VImageDimension>
void ItkImageResampling (const itk::Image< TPixel, VImageDimension > *itkImage)
 Templated method for ITK image type which performs the resampling with an itk filter. More...
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

double m_ResampledX
 length of x dimension of output image in pixels More...
 
double m_ResampledY
 length of y dimension of output image in pixels More...
 
double m_ResampledZ
 length of z dimension of output image in pixels (if 2D, default is set to 1) More...
 

Additional Inherited Members

- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef mitk::Image InputImageType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Static Protected Member Functions inherited from mitk::ImageSource
static itk::ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Reduces the resolution of a ToF distance image. Although it is meant to be used for ToF distance images, it should work for any 2D or 3D images. The dimensions (in pixels) of the desired image are taken as input parameters, and an image with these specified dimensions is created.

Definition at line 33 of file mitkToFImageDownsamplingFilter.h.

Constructor & Destructor Documentation

◆ ToFImageDownsamplingFilter()

mitk::ToFImageDownsamplingFilter::ToFImageDownsamplingFilter ( )
protected

Standard constructor.

◆ ~ToFImageDownsamplingFilter()

mitk::ToFImageDownsamplingFilter::~ToFImageDownsamplingFilter ( )
overrideprotected

Standard destructor.

Member Function Documentation

◆ Clone()

Pointer mitk::ToFImageDownsamplingFilter::Clone ( ) const

◆ GenerateData()

void mitk::ToFImageDownsamplingFilter::GenerateData ( )
overrideprotected

Method generating the output of this filter. Called in the updated process of the pipeline. This method calls the AccessFixedDimensionByItk class with the ItkImageResampling function below.

◆ GetResampledX()

virtual double mitk::ToFImageDownsamplingFilter::GetResampledX ( )
virtual

◆ GetResampledY()

virtual double mitk::ToFImageDownsamplingFilter::GetResampledY ( )
virtual

◆ GetResampledZ()

virtual double mitk::ToFImageDownsamplingFilter::GetResampledZ ( )
virtual

◆ ItkImageResampling()

template<typename TPixel , unsigned int VImageDimension>
void mitk::ToFImageDownsamplingFilter::ItkImageResampling ( const itk::Image< TPixel, VImageDimension > *  itkImage)
protected

Templated method for ITK image type which performs the resampling with an itk filter.

Parameters
itkImageis the input to the filter converted to ITK format

◆ mitkClassMacro()

mitk::ToFImageDownsamplingFilter::mitkClassMacro ( ToFImageDownsamplingFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::ToFImageDownsamplingFilter::New ( )
static

◆ SetResampledX()

virtual void mitk::ToFImageDownsamplingFilter::SetResampledX ( double  _arg)
virtual

◆ SetResampledY()

virtual void mitk::ToFImageDownsamplingFilter::SetResampledY ( double  _arg)
virtual

◆ SetResampledZ()

virtual void mitk::ToFImageDownsamplingFilter::SetResampledZ ( double  _arg)
virtual

Member Data Documentation

◆ m_ResampledX

double mitk::ToFImageDownsamplingFilter::m_ResampledX
protected

length of x dimension of output image in pixels

Definition at line 73 of file mitkToFImageDownsamplingFilter.h.

◆ m_ResampledY

double mitk::ToFImageDownsamplingFilter::m_ResampledY
protected

length of y dimension of output image in pixels

Definition at line 74 of file mitkToFImageDownsamplingFilter.h.

◆ m_ResampledZ

double mitk::ToFImageDownsamplingFilter::m_ResampledZ
protected

length of z dimension of output image in pixels (if 2D, default is set to 1)

Definition at line 75 of file mitkToFImageDownsamplingFilter.h.


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