Medical Imaging Interaction Toolkit  2018.4.99-b585543d
Medical Imaging Interaction Toolkit
mitk::BilateralFilter Class Reference

#include <mitkBilateralFilter.h>

Inheritance diagram for mitk::BilateralFilter:
Collaboration diagram for mitk::BilateralFilter:

Public Member Functions

 mitkClassMacro (BilateralFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetDomainSigma (float _arg)
 
virtual void SetRangeSigma (float _arg)
 
virtual void SetAutoKernel (bool _arg)
 
virtual void SetKernelRadius (unsigned int _arg)
 
virtual float GetDomainSigma ()
 
virtual float GetRangeSigma ()
 
virtual bool GetAutoKernel ()
 
virtual unsigned int GetKernelRadius ()
 
- 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

 BilateralFilter ()
 standard constructor More...
 
 ~BilateralFilter () override
 standard destructor More...
 
void GenerateOutputInformation () override
 Method generating the output information of this filter (e.g. image dimension, image type, etc.). The interface ImageToImageFilter requires this implementation. Everything is taken from the input image. More...
 
void GenerateData () override
 Method generating the output of this filter. Called in the updated process of the pipeline. This method generates the smoothed output image. More...
 
template<typename TPixel , unsigned int VImageDimension>
void ItkImageProcessing (const itk::Image< TPixel, VImageDimension > *itkImage)
 Internal templated method calling the ITK bilteral filter. Here the actual filtering is performed. 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

float m_DomainSigma
 
float m_RangeSigma
 Sigma of the gaussian kernel. See ITK docu. More...
 
bool m_AutoKernel
 Sigma of the range mask kernel. See ITK docu. More...
 
unsigned int m_KernelRadius
 

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_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

Definition at line 24 of file mitkBilateralFilter.h.

Constructor & Destructor Documentation

◆ BilateralFilter()

mitk::BilateralFilter::BilateralFilter ( )
protected

standard constructor

Definition at line 18 of file mitkBilateralFilter.cpp.

◆ ~BilateralFilter()

mitk::BilateralFilter::~BilateralFilter ( )
overrideprotected

standard destructor

Definition at line 24 of file mitkBilateralFilter.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::BilateralFilter::Clone ( ) const

◆ GenerateData()

void mitk::BilateralFilter::GenerateData ( )
overrideprotected

Method generating the output of this filter. Called in the updated process of the pipeline. This method generates the smoothed output image.

Definition at line 28 of file mitkBilateralFilter.cpp.

References AccessFixedDimensionByItk, mitk::ImageToImageFilter::GetInput(), ItkImageProcessing(), and MITK_ERROR.

◆ GenerateOutputInformation()

void mitk::BilateralFilter::GenerateOutputInformation ( )
overrideprotected

Method generating the output information of this filter (e.g. image dimension, image type, etc.). The interface ImageToImageFilter requires this implementation. Everything is taken from the input image.

Definition at line 84 of file mitkBilateralFilter.cpp.

References mitk::ImageToImageFilter::GetInput(), and mitk::ImageSource::GetOutput().

◆ GetAutoKernel()

virtual bool mitk::BilateralFilter::GetAutoKernel ( )
virtual

◆ GetDomainSigma()

virtual float mitk::BilateralFilter::GetDomainSigma ( )
virtual

◆ GetKernelRadius()

virtual unsigned int mitk::BilateralFilter::GetKernelRadius ( )
virtual

◆ GetRangeSigma()

virtual float mitk::BilateralFilter::GetRangeSigma ( )
virtual

◆ ItkImageProcessing()

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

Internal templated method calling the ITK bilteral filter. Here the actual filtering is performed.

Definition at line 61 of file mitkBilateralFilter.cpp.

References mitk::CastToMitkImage(), mitk::ImageSource::GetOutput(), m_AutoKernel, m_DomainSigma, m_KernelRadius, and m_RangeSigma.

Referenced by GenerateData().

◆ mitkClassMacro()

mitk::BilateralFilter::mitkClassMacro ( BilateralFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::BilateralFilter::New ( )
static

◆ SetAutoKernel()

virtual void mitk::BilateralFilter::SetAutoKernel ( bool  _arg)
virtual

◆ SetDomainSigma()

virtual void mitk::BilateralFilter::SetDomainSigma ( float  _arg)
virtual

◆ SetKernelRadius()

virtual void mitk::BilateralFilter::SetKernelRadius ( unsigned int  _arg)
virtual

◆ SetRangeSigma()

virtual void mitk::BilateralFilter::SetRangeSigma ( float  _arg)
virtual

Member Data Documentation

◆ m_AutoKernel

bool mitk::BilateralFilter::m_AutoKernel
protected

Sigma of the range mask kernel. See ITK docu.

Definition at line 68 of file mitkBilateralFilter.h.

Referenced by ItkImageProcessing().

◆ m_DomainSigma

float mitk::BilateralFilter::m_DomainSigma
protected

Definition at line 66 of file mitkBilateralFilter.h.

Referenced by ItkImageProcessing().

◆ m_KernelRadius

unsigned int mitk::BilateralFilter::m_KernelRadius
protected

Definition at line 69 of file mitkBilateralFilter.h.

Referenced by ItkImageProcessing().

◆ m_RangeSigma

float mitk::BilateralFilter::m_RangeSigma
protected

Sigma of the gaussian kernel. See ITK docu.

Definition at line 67 of file mitkBilateralFilter.h.

Referenced by ItkImageProcessing().


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