#include <otbFrostImageFilter.h>

Inheritance diagram for otb::FrostImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::FrostImageFilter< TInputImage, TOutputImage >:

typedef TInputImage	InputImageType

typedef TOutputImage	OutputImageType

typedef FrostImageFilter	Self

typedef itk::ImageToImageFilter< InputImageType, OutputImageType >	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef InputImageType::PixelType	InputPixelType

typedef OutputImageType::PixelType	OutputPixelType

typedef itk::NumericTraits< InputPixelType >::RealType	InputRealType

typedef InputImageType::RegionType	InputImageRegionType

typedef OutputImageType::RegionType	OutputImageRegionType

typedef InputImageType::SizeType	SizeType

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

SizeType	m_Radius

double	m_Deramp

static Pointer	New ()

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

virtual void	SetRadius (SizeType _arg)

virtual const SizeType &	GetRadius () const

virtual void	SetDeramp (double _arg)

virtual const double &	GetDeramp () const

void	GenerateInputRequestedRegion () override

	FrostImageFilter ()

	~FrostImageFilter () override

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

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override

	FrostImageFilter (const Self &)=delete

void	operator= (const Self &)=delete

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::FrostImageFilter< TInputImage, TOutputImage >

Anti-speckle image filter.

Uses a negative exponential convolution kernel. The kernel is defined as follows: exp(-A*D), where D is the distance from the current pixel to the center pixel A = k*Ci*Ci with Ci = VAR[I]/ (E[I]*E[I]) The final result is normalized by the sum of the kernel coefficients.

(http://www.isprs.org/proceedings/XXXV/congress/comm2/papers/110.pdf)

Definition at line 47 of file otbFrostImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::FrostImageFilter< TInputImage, TOutputImage >::ConstPointer

typedef to simplify variables definition and declaration.

Definition at line 65 of file otbFrostImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType otb::FrostImageFilter< TInputImage, TOutputImage >::InputImageRegionType

typedef to simplify variables definition and declaration.

Definition at line 80 of file otbFrostImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::FrostImageFilter< TInputImage, TOutputImage >::InputImageType

typedef to simplify variables definition and declaration.

Definition at line 56 of file otbFrostImageFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType otb::FrostImageFilter< TInputImage, TOutputImage >::InputPixelType

Supported images definition.

Definition at line 71 of file otbFrostImageFilter.h.

◆ InputRealType

template<class TInputImage , class TOutputImage >

typedef itk::NumericTraits<InputPixelType>::RealType otb::FrostImageFilter< TInputImage, TOutputImage >::InputRealType

"typedef" to define a real.

Definition at line 78 of file otbFrostImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::FrostImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

typedef to simplify variables definition and declaration.

Definition at line 81 of file otbFrostImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::FrostImageFilter< TInputImage, TOutputImage >::OutputImageType

typedef to simplify variables definition and declaration.

Definition at line 59 of file otbFrostImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType otb::FrostImageFilter< TInputImage, TOutputImage >::OutputPixelType

typedef to simplify variables definition and declaration.

Definition at line 75 of file otbFrostImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<Self> otb::FrostImageFilter< TInputImage, TOutputImage >::Pointer

typedef to simplify variables definition and declaration.

Definition at line 64 of file otbFrostImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >

typedef FrostImageFilter otb::FrostImageFilter< TInputImage, TOutputImage >::Self

typedef for standard classes.

Definition at line 62 of file otbFrostImageFilter.h.

◆ SizeType

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType otb::FrostImageFilter< TInputImage, TOutputImage >::SizeType

"typedef" to define an image size.

Definition at line 84 of file otbFrostImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >

typedef itk::ImageToImageFilter<InputImageType, OutputImageType> otb::FrostImageFilter< TInputImage, TOutputImage >::Superclass

typedef to simplify variables definition and declaration.

Definition at line 63 of file otbFrostImageFilter.h.

Constructor & Destructor Documentation

◆ FrostImageFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::FrostImageFilter< TInputImage, TOutputImage >::FrostImageFilter

protected

typedef to simplify variables definition and declaration.

Definition at line 41 of file otbFrostImageFilter.hxx.

◆ ~FrostImageFilter()

template<class TInputImage , class TOutputImage >

otb::FrostImageFilter< TInputImage, TOutputImage >::~FrostImageFilter ( )

inlineoverrideprotected

typedef to simplify variables definition and declaration.

Definition at line 105 of file otbFrostImageFilter.h.

◆ FrostImageFilter() [2/2]

template<class TInputImage , class TOutputImage >

otb::FrostImageFilter< TInputImage, TOutputImage >::FrostImageFilter ( const Self & )

privatedelete

typedef to simplify variables definition and declaration.

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer otb::FrostImageFilter< TInputImage, TOutputImage >::CreateAnother ( void ) const

typedef to simplify variables definition and declaration.

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >

void otb::FrostImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion

override

To be allowed to use the pipeline method FrostImageFilter needs an input processing area larger than the output one.

See also: ImageToImageFilter::GenerateInputRequestedRegion()

Definition at line 49 of file otbFrostImageFilter.hxx.

◆ GetDeramp()

template<class TInputImage , class TOutputImage >

virtual const double& otb::FrostImageFilter< TInputImage, TOutputImage >::GetDeramp ( ) const

virtual

Get the damping factor.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >

virtual const char* otb::FrostImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Return the class name.

◆ GetRadius()

template<class TInputImage , class TOutputImage >

virtual const SizeType& otb::FrostImageFilter< TInputImage, TOutputImage >::GetRadius ( ) const

virtual

Get the radius used to define the neighborhood for the filter calculation.

◆ New()

template<class TInputImage , class TOutputImage >

static Pointer otb::FrostImageFilter< TInputImage, TOutputImage >::New ( )

static

"object factory" management method.

◆ operator=()

template<class TInputImage , class TOutputImage >

void otb::FrostImageFilter< TInputImage, TOutputImage >::operator= ( const Self & )

privatedelete

typedef to simplify variables definition and declaration.

◆ PrintSelf()

template<class TInputImage , class TOutput >

void otb::FrostImageFilter< TInputImage, TOutput >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overrideprotected

Standard "PrintSelf" method

Definition at line 211 of file otbFrostImageFilter.hxx.

◆ SetDeramp()

template<class TInputImage , class TOutputImage >

virtual void otb::FrostImageFilter< TInputImage, TOutputImage >::SetDeramp ( double _arg )

virtual

Set the damping factor.

◆ SetRadius()

template<class TInputImage , class TOutputImage >

virtual void otb::FrostImageFilter< TInputImage, TOutputImage >::SetRadius ( SizeType _arg )

virtual

Set the radius used to define the neighborhood for the filter calculation.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::FrostImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		itk::ThreadIdType	threadId
	)

overrideprotected

FrostImageFilter can be implemented for a multithreaded filter treatment. Thus, this implementation give the ThreadedGenerateData() method. that is called for each process thread. Image data are automatically allocated through the parent class calling the ThreadedGenerateData() method. ThreadedGenerateData() can only write the area of the image specified by the parameter "outputRegionForThread"

See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Definition at line 97 of file otbFrostImageFilter.hxx.

Member Data Documentation

◆ InputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::FrostImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

Extract input and output images sizes.

Definition at line 51 of file otbFrostImageFilter.h.

◆ m_Deramp

template<class TInputImage , class TOutputImage >

double otb::FrostImageFilter< TInputImage, TOutputImage >::m_Deramp

private

Decrease factor declaration

Definition at line 128 of file otbFrostImageFilter.h.

◆ m_Radius

template<class TInputImage , class TOutputImage >

SizeType otb::FrostImageFilter< TInputImage, TOutputImage >::m_Radius

private

Radius declaration

Definition at line 125 of file otbFrostImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::FrostImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

typedef to simplify variables definition and declaration.

Definition at line 52 of file otbFrostImageFilter.h.

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

Detailed Description

template<class TInputImage, class TOutputImage> class otb::FrostImageFilter< TInputImage, TOutputImage >

Member Typedef Documentation

◆ ConstPointer

◆ InputImageRegionType

◆ InputImageType

◆ InputPixelType

◆ InputRealType

◆ OutputImageRegionType

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ FrostImageFilter() [1/2]

◆ ~FrostImageFilter()

◆ FrostImageFilter() [2/2]

Member Function Documentation

◆ CreateAnother()

◆ GenerateInputRequestedRegion()

◆ GetDeramp()

◆ GetNameOfClass()

◆ GetRadius()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetDeramp()

◆ SetRadius()

◆ ThreadedGenerateData()

Member Data Documentation

◆ InputImageDimension

◆ m_Deramp

◆ m_Radius

◆ OutputImageDimension

template<class TInputImage, class TOutputImage>
class otb::FrostImageFilter< TInputImage, TOutputImage >