PCL
pcl::AdaptiveLocalFilter Class Reference

Adaptive, local noise reduction filter in the spatial domain. More...

#include <AdaptiveLocalFilter.h>

+ Inheritance diagram for pcl::AdaptiveLocalFilter:

Public Member Functions

 AdaptiveLocalFilter (const AdaptiveLocalFilter &)=default
 
 AdaptiveLocalFilter (double sigma, int size=5, bool useMAD=false)
 
 ~AdaptiveLocalFilter () override
 
void SetSigma (double sigma)
 
void SetSize (int size)
 
double Sigma () const
 
int Size () const
 
void UseMAD (bool useMAD=true)
 
bool UsingMAD () const
 
- Public Member Functions inherited from pcl::ImageTransformation
 ImageTransformation ()=default
 
 ImageTransformation (const ImageTransformation &)=default
 
virtual ~ImageTransformation ()
 
template<class P >
GenericImage< P > & operator>> (GenericImage< P > &image) const
 
ImageVariantoperator>> (ImageVariant &image) const
 
- Public Member Functions inherited from pcl::ParallelProcess
 ParallelProcess ()=default
 
 ParallelProcess (const ParallelProcess &)=default
 
virtual ~ParallelProcess ()
 
void DisableParallelProcessing (bool disable=true) noexcept
 
void EnableParallelProcessing (bool enable=true, int maxProcessors=0) noexcept
 
bool IsParallelProcessingEnabled () const noexcept
 
int MaxProcessors () const noexcept
 
ParallelProcessoperator= (const ParallelProcess &)=default
 
void SetMaxProcessors (int maxProcessors) noexcept
 
void Swap (ParallelProcess &process) noexcept
 

Protected Member Functions

void Apply (pcl::DImage &) const override
 
void Apply (pcl::Image &) const override
 
void Apply (pcl::UInt16Image &) const override
 
void Apply (pcl::UInt32Image &) const override
 
void Apply (pcl::UInt8Image &) const override
 
- Protected Member Functions inherited from pcl::ImageTransformation
virtual void Apply (pcl::ComplexImage &image) const
 
virtual void Apply (pcl::DComplexImage &image) const
 

Detailed Description

Implementation of the adaptive, local noise reduction filter in the spatial domain as described by González and Woods.

References

R.C. González and R.E. Woods, Digital Image Processing, Third Edition, Pearson / Prentice Hall, 2008. pp 330-332.

Definition at line 80 of file AdaptiveLocalFilter.h.

Constructor & Destructor Documentation

◆ AdaptiveLocalFilter() [1/2]

pcl::AdaptiveLocalFilter::AdaptiveLocalFilter ( double  sigma,
int  size = 5,
bool  useMAD = false 
)
inline

Constructs an AdaptiveLocalFilter instance.

Parameters
sigmaStandard deviation or median absolute deviation from the median (MAD) of the noise (see the useMAD parameter). If the MAD is used, the specified sigma value must be consistent with the standard deviation of a normal distribution (typically, the computed MAD estimate must be multiplied by 1.4826).
sizeFilter size in pixels. This is the length of a side of the square pixel neighborhood used by the adaptive filter. The filter size must be an odd number greater than or equal to three. If an even size is specified, the smallest odd size greater than the specified value will be used. The default size is five pixels.
useMADIf true, use the median absolute deviation from the median (MAD) instead of variance / standard deviation for noise estimates. Note that this changes the meaning of the sigma parameter. The default value is false (variance is used by default).

Definition at line 108 of file AdaptiveLocalFilter.h.

◆ AdaptiveLocalFilter() [2/2]

pcl::AdaptiveLocalFilter::AdaptiveLocalFilter ( const AdaptiveLocalFilter )
default

Copy constructor.

◆ ~AdaptiveLocalFilter()

pcl::AdaptiveLocalFilter::~AdaptiveLocalFilter ( )
inlineoverride

Destroys this AdaptiveLocalFilter object.

Definition at line 123 of file AdaptiveLocalFilter.h.

Member Function Documentation

◆ Apply() [1/5]

void pcl::AdaptiveLocalFilter::Apply ( pcl::DImage image) const
overrideprotectedvirtual

Applies this transformation to a 64-bit floating point image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [2/5]

void pcl::AdaptiveLocalFilter::Apply ( pcl::Image image) const
overrideprotectedvirtual

Applies this transformation to a 32-bit floating point image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [3/5]

void pcl::AdaptiveLocalFilter::Apply ( pcl::UInt16Image image) const
overrideprotectedvirtual

Applies this transformation to a 16-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [4/5]

void pcl::AdaptiveLocalFilter::Apply ( pcl::UInt32Image image) const
overrideprotectedvirtual

Applies this transformation to a 32-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [5/5]

void pcl::AdaptiveLocalFilter::Apply ( pcl::UInt8Image image) const
overrideprotectedvirtual

Applies this transformation to an 8-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ SetSigma()

void pcl::AdaptiveLocalFilter::SetSigma ( double  sigma)
inline

Sets the standard deviation or median absolute deviation from the median (MAD) of the noise in this adaptive filter. The specified sigma must be a positive, nonzero value (a zero noise value is legal, but the filter will obviously have no effect).

The meaning of the specified sigma value depends on whether this filter uses variance or MAD for noise estimates–see the UsingMAD() member function and the class constructor for more information.

Definition at line 168 of file AdaptiveLocalFilter.h.

References pcl::Max().

◆ SetSize()

void pcl::AdaptiveLocalFilter::SetSize ( int  size)
inline

Sets the filter size in pixels.

Definition at line 138 of file AdaptiveLocalFilter.h.

References pcl::Max().

◆ Sigma()

double pcl::AdaptiveLocalFilter::Sigma ( ) const
inline

Returns the standard deviation or median absolute deviation from the median (MAD) of the noise in this adaptive filter.

The meaning of the returned value depends on whether this filter uses variance or MAD for noise estimates –see the UsingMAD() member function and the class constructor for more information.

Definition at line 153 of file AdaptiveLocalFilter.h.

◆ Size()

int pcl::AdaptiveLocalFilter::Size ( ) const
inline

Returns the filter size in pixels.

Definition at line 130 of file AdaptiveLocalFilter.h.

◆ UseMAD()

void pcl::AdaptiveLocalFilter::UseMAD ( bool  useMAD = true)
inline

Sets the way this adaptive filter interprets noise estimates: either as the median absolute deviation from the median (MAD) or as the standard deviation of the noise in the target image.

Definition at line 188 of file AdaptiveLocalFilter.h.

◆ UsingMAD()

bool pcl::AdaptiveLocalFilter::UsingMAD ( ) const
inline

Returns true iff this adaptive filter uses median absolute deviation (MAD) instead of variance / standard deviation to interpret noise estimates.

Definition at line 178 of file AdaptiveLocalFilter.h.


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