#include <itkBilateralImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::BilateralImageFilter< TInputImage, TOutputImage >

Blurs an image while preserving edges.

This filter uses bilateral filtering to blur an image using both domain and range "neighborhoods". Pixels that are close to a pixel in the image domain and similar to a pixel in the image range are used to calculate the filtered value. Two gaussian kernels (one in the image domain and one in the image range) are used to smooth the image. The result is an image that is smoothed in homogeneous regions yet has edges preserved. The result is similar to anisotropic diffusion but the implementation in non-iterative. Another benefit to bilateral filtering is that any distance metric can be used for kernel smoothing the image range. Hence, color images can be smoothed as vector images, using the CIE distances between intensity values as the similarity metric (the Gaussian kernel for the image domain is evaluated using CIE distances). A separate version of this filter will be designed for color and vector images.

Bilateral filtering is capable of reducing the noise in an image by an order of magnitude while maintaining edges.

The bilateral operator used here was described by Tomasi and Manduchi (Bilateral Filtering for Gray and ColorImages. IEEE ICCV. 1998.)

See also: GaussianOperator; RecursiveGaussianImageFilter; DiscreteGaussianImageFilter; AnisotropicDiffusionImageFilter; Image; Neighborhood; NeighborhoodOperator

Todo:

Support color images

Support vector images

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 75 of file itkBilateralImageFilter.h.

Inheritance diagram for itk::BilateralImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::BilateralImageFilter< TInputImage, TOutputImage >:

Public Types
using	ArrayType = FixedArray< double, Self::ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	GaussianImageType = Image< double, Self::ImageDimension >

using	InputImageType = TInputImage

using	InputInternalPixelType = typename TInputImage::InternalPixelType

using	InputPixelType = typename TInputImage::PixelType

using	KernelConstIteratorType = typename KernelType::ConstIterator

using	KernelIteratorType = typename KernelType::Iterator

using	KernelType = Neighborhood< double, Self::ImageDimension >

using	NeighborhoodIteratorType = ConstNeighborhoodIterator< TInputImage >

using	OutputImageType = TOutputImage

using	OutputInternalPixelType = typename TOutputImage::InternalPixelType

using	OutputPixelRealType = typename NumericTraits< OutputPixelType >::RealType

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = BilateralImageFilter

using	SizeType = typename KernelType::SizeType

using	SizeValueType = typename KernelType::SizeValueType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

virtual const SizeType &	GetRadius () const

void	SetDomainSigma (const double v)

void	SetRadius (const SizeValueType)

virtual void	SetRadius (SizeType _arg)


virtual void	SetDomainSigma (ArrayType _arg)

virtual const ArrayType	GetDomainSigma () const

virtual void	SetDomainMu (double _arg)

virtual const double &	GetDomainMu () const

virtual void	SetRangeSigma (double _arg)

virtual double	GetRangeSigma () const

virtual unsigned int	GetFilterDimensionality () const

virtual void	SetFilterDimensionality (unsigned int _arg)


virtual void	AutomaticKernelSizeOn ()

virtual bool	GetAutomaticKernelSize () const

virtual void	SetAutomaticKernelSize (bool _arg)


virtual void	SetNumberOfRangeGaussianSamples (unsigned long _arg)

virtual unsigned long	GetNumberOfRangeGaussianSamples () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	BeforeThreadedGenerateData () override

	BilateralImageFilter ()

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~BilateralImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
bool	m_AutomaticKernelSize {}

double	m_DomainMu {}

ArrayType	m_DomainSigma {}

double	m_DynamicRange {}

double	m_DynamicRangeUsed {}

unsigned int	m_FilterDimensionality {}

KernelType	m_GaussianKernel {}

unsigned long	m_NumberOfRangeGaussianSamples {}

SizeType	m_Radius {}

std::vector< double >	m_RangeGaussianTable {}

double	m_RangeMu {}

double	m_RangeSigma {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::ArrayType = FixedArray<double, Self::ImageDimension>

Typedef of double containers

Definition at line 112 of file itkBilateralImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 84 of file itkBilateralImageFilter.h.

◆ GaussianImageType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::GaussianImageType = Image<double, Self::ImageDimension>

Gaussian image type

Definition at line 127 of file itkBilateralImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type information.

Definition at line 93 of file itkBilateralImageFilter.h.

◆ InputInternalPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 105 of file itkBilateralImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 104 of file itkBilateralImageFilter.h.

◆ KernelConstIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::KernelConstIteratorType = typename KernelType::ConstIterator

Definition at line 124 of file itkBilateralImageFilter.h.

◆ KernelIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::KernelIteratorType = typename KernelType::Iterator

Kernel iterator.

Definition at line 123 of file itkBilateralImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::KernelType = Neighborhood<double, Self::ImageDimension>

Kernel type alias.

Definition at line 118 of file itkBilateralImageFilter.h.

◆ NeighborhoodIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::NeighborhoodIteratorType = ConstNeighborhoodIterator<TInputImage>

Neighborhood iterator types.

Definition at line 115 of file itkBilateralImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 94 of file itkBilateralImageFilter.h.

◆ OutputInternalPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 102 of file itkBilateralImageFilter.h.

◆ OutputPixelRealType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::OutputPixelRealType = typename NumericTraits<OutputPixelType>::RealType

Definition at line 103 of file itkBilateralImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< 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 101 of file itkBilateralImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 83 of file itkBilateralImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::Self = BilateralImageFilter

Standard class type aliases.

Definition at line 81 of file itkBilateralImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::SizeType = typename KernelType::SizeType

Definition at line 119 of file itkBilateralImageFilter.h.

◆ SizeValueType

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::SizeValueType = typename KernelType::SizeValueType

Definition at line 120 of file itkBilateralImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::BilateralImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 82 of file itkBilateralImageFilter.h.

Constructor & Destructor Documentation

◆ BilateralImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::BilateralImageFilter< TInputImage, TOutputImage >::BilateralImageFilter ( )

protected

Constructor.

◆ ~BilateralImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::BilateralImageFilter< TInputImage, TOutputImage >::~BilateralImageFilter ( )

overrideprotecteddefault

Destructor.

Member Function Documentation

◆ AutomaticKernelSizeOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::AutomaticKernelSizeOn ( )

virtual

Control automatic kernel size determination. When automatic is "on", the kernel size is a function of the domain sigma. When automatic is "off", the kernel size is whatever is specified by the user.

See also: SetRadius()

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Do some setup before the ThreadedGenerateData

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

Standard pipeline method. This filter is implemented as a multi-threaded filter.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

BilateralImageFilter needs a larger input requested region than the output requested region (larger by the size of the domain Gaussian kernel). As such, BilateralImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also: ImageToImageFilter::GenerateInputRequestedRegion()

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

◆ GetAutomaticKernelSize()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::BilateralImageFilter< TInputImage, TOutputImage >::GetAutomaticKernelSize ( ) const

virtual

Control automatic kernel size determination. When automatic is "on", the kernel size is a function of the domain sigma. When automatic is "off", the kernel size is whatever is specified by the user.

See also: SetRadius()

◆ GetDomainMu()

template<typename TInputImage , typename TOutputImage >

virtual const double & itk::BilateralImageFilter< TInputImage, TOutputImage >::GetDomainMu ( ) const

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ GetDomainSigma()

template<typename TInputImage , typename TOutputImage >

virtual const ArrayType itk::BilateralImageFilter< TInputImage, TOutputImage >::GetDomainSigma ( ) const

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ GetFilterDimensionality()

template<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::BilateralImageFilter< TInputImage, TOutputImage >::GetFilterDimensionality ( ) const

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::BilateralImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetNumberOfRangeGaussianSamples()

template<typename TInputImage , typename TOutputImage >

virtual unsigned long itk::BilateralImageFilter< TInputImage, TOutputImage >::GetNumberOfRangeGaussianSamples ( ) const

virtual

Set/Get the number of samples in the approximation to the Gaussian used for the range smoothing. Samples are only generated in the range of [0, 4*m_RangeSigma]. Default is 100.

◆ GetRadius()

template<typename TInputImage , typename TOutputImage >

virtual const SizeType & itk::BilateralImageFilter< TInputImage, TOutputImage >::GetRadius ( ) const

virtual

◆ GetRangeSigma()

template<typename TInputImage , typename TOutputImage >

virtual double itk::BilateralImageFilter< TInputImage, TOutputImage >::GetRangeSigma ( ) const

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::BilateralImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

PrintSelf.

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

◆ SetAutomaticKernelSize()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetAutomaticKernelSize ( bool _arg )

virtual

Control automatic kernel size determination. When automatic is "on", the kernel size is a function of the domain sigma. When automatic is "off", the kernel size is whatever is specified by the user.

See also: SetRadius()

◆ SetDomainMu()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetDomainMu ( double _arg )

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ SetDomainSigma() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetDomainSigma ( ArrayType _arg )

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ SetDomainSigma() [2/2]

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetDomainSigma ( const double v )

inline

Convenience get/set methods for setting all domain parameters to the same values.

Definition at line 145 of file itkBilateralImageFilter.h.

◆ SetFilterDimensionality()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetFilterDimensionality ( unsigned int _arg )

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

◆ SetNumberOfRangeGaussianSamples()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetNumberOfRangeGaussianSamples ( unsigned long _arg )

virtual

Set/Get the number of samples in the approximation to the Gaussian used for the range smoothing. Samples are only generated in the range of [0, 4*m_RangeSigma]. Default is 100.

◆ SetRadius() [1/2]

template<typename TInputImage , typename TOutputImage >

void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetRadius ( const SizeValueType )

Set/Get the kernel radius, specified in pixels. This parameter is used only when AutomaticNeighborhoodSize is "off".

◆ SetRadius() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetRadius ( SizeType _arg )

virtual

◆ SetRangeSigma()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BilateralImageFilter< TInputImage, TOutputImage >::SetRangeSigma ( double _arg )

virtual

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::BilateralImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 109 of file itkBilateralImageFilter.h.

◆ m_AutomaticKernelSize

template<typename TInputImage , typename TOutputImage >

bool itk::BilateralImageFilter< TInputImage, TOutputImage >::m_AutomaticKernelSize {}

private

Definition at line 230 of file itkBilateralImageFilter.h.

◆ m_DomainMu

template<typename TInputImage , typename TOutputImage >

double itk::BilateralImageFilter< TInputImage, TOutputImage >::m_DomainMu {}

private

Multiplier used to define statistical thresholds. Gaussians are only evaluated to m_DomainMu*m_DomainSigma or m_RangeMu*m_RangeSigma.

Definition at line 221 of file itkBilateralImageFilter.h.

◆ m_DomainSigma

template<typename TInputImage , typename TOutputImage >

ArrayType itk::BilateralImageFilter< TInputImage, TOutputImage >::m_DomainSigma {}

private

The standard deviation of the gaussian blurring kernel in each dimensional direction. Units match image spacing units.

Definition at line 217 of file itkBilateralImageFilter.h.

◆ m_DynamicRange

template<typename TInputImage , typename TOutputImage >

double itk::BilateralImageFilter< TInputImage, TOutputImage >::m_DynamicRange {}

private

Definition at line 234 of file itkBilateralImageFilter.h.

◆ m_DynamicRangeUsed

template<typename TInputImage , typename TOutputImage >

double itk::BilateralImageFilter< TInputImage, TOutputImage >::m_DynamicRangeUsed {}

private

Definition at line 235 of file itkBilateralImageFilter.h.

◆ m_FilterDimensionality

template<typename TInputImage , typename TOutputImage >

unsigned int itk::BilateralImageFilter< TInputImage, TOutputImage >::m_FilterDimensionality {}

private

Number of dimensions to process. Default is all dimensions

Definition at line 225 of file itkBilateralImageFilter.h.

◆ m_GaussianKernel

template<typename TInputImage , typename TOutputImage >

KernelType itk::BilateralImageFilter< TInputImage, TOutputImage >::m_GaussianKernel {}

private

Gaussian kernel used for smoothing in the spatial domain

Definition at line 228 of file itkBilateralImageFilter.h.

◆ m_NumberOfRangeGaussianSamples

template<typename TInputImage , typename TOutputImage >

unsigned long itk::BilateralImageFilter< TInputImage, TOutputImage >::m_NumberOfRangeGaussianSamples {}

private

Variables for the lookup table of range gaussian values

Definition at line 233 of file itkBilateralImageFilter.h.

◆ m_Radius

template<typename TInputImage , typename TOutputImage >

SizeType itk::BilateralImageFilter< TInputImage, TOutputImage >::m_Radius {}

private

Definition at line 229 of file itkBilateralImageFilter.h.

◆ m_RangeGaussianTable

template<typename TInputImage , typename TOutputImage >

std::vector<double> itk::BilateralImageFilter< TInputImage, TOutputImage >::m_RangeGaussianTable {}

private

Definition at line 236 of file itkBilateralImageFilter.h.

◆ m_RangeMu

template<typename TInputImage , typename TOutputImage >

double itk::BilateralImageFilter< TInputImage, TOutputImage >::m_RangeMu {}

private

Definition at line 222 of file itkBilateralImageFilter.h.

◆ m_RangeSigma

template<typename TInputImage , typename TOutputImage >

double itk::BilateralImageFilter< TInputImage, TOutputImage >::m_RangeSigma {}

private

The standard deviation of the gaussian blurring kernel in the image range. Units are intensity.

Definition at line 213 of file itkBilateralImageFilter.h.

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

itkBilateralImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ArrayType

◆ ConstPointer

◆ GaussianImageType

◆ InputImageType

◆ InputInternalPixelType

◆ InputPixelType

◆ KernelConstIteratorType

◆ KernelIteratorType

◆ KernelType

◆ NeighborhoodIteratorType

◆ OutputImageType

◆ OutputInternalPixelType

◆ OutputPixelRealType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ SizeType

◆ SizeValueType

◆ Superclass

Constructor & Destructor Documentation

◆ BilateralImageFilter()

◆ ~BilateralImageFilter()

Member Function Documentation

◆ AutomaticKernelSizeOn()

◆ BeforeThreadedGenerateData()

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GetAutomaticKernelSize()

◆ GetDomainMu()

◆ GetDomainSigma()

◆ GetFilterDimensionality()

◆ GetNameOfClass()

◆ GetNumberOfRangeGaussianSamples()

◆ GetRadius()

◆ GetRangeSigma()

◆ New()

◆ PrintSelf()

◆ SetAutomaticKernelSize()

◆ SetDomainMu()

◆ SetDomainSigma() [1/2]

◆ SetDomainSigma() [2/2]

◆ SetFilterDimensionality()

◆ SetNumberOfRangeGaussianSamples()

◆ SetRadius() [1/2]

◆ SetRadius() [2/2]

◆ SetRangeSigma()

Member Data Documentation

◆ ImageDimension

◆ m_AutomaticKernelSize

◆ m_DomainMu

◆ m_DomainSigma

◆ m_DynamicRange

◆ m_DynamicRangeUsed

◆ m_FilterDimensionality

◆ m_GaussianKernel

◆ m_NumberOfRangeGaussianSamples

◆ m_Radius

◆ m_RangeGaussianTable

◆ m_RangeMu

◆ m_RangeSigma