PCL
pcl::SeparableMedianFilter Class Reference

A two-dimensional separable filter that approximates a median filter. More...

#include <SeparableMedianFilter.h>

+ Inheritance diagram for pcl::SeparableMedianFilter:

Public Member Functions

 SeparableMedianFilter (const SeparableMedianFilter &)=default
 
 SeparableMedianFilter (int size=3)
 
 ~SeparableMedianFilter () override
 
void SetSize (int size)
 
int Size () 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

TODO: Write a detailed description for SeparableMedianFilter.

Definition at line 75 of file SeparableMedianFilter.h.

Constructor & Destructor Documentation

◆ SeparableMedianFilter() [1/2]

pcl::SeparableMedianFilter::SeparableMedianFilter ( int  size = 3)
inline

Constructs a SeparableMedianFilter object with the specified size.

Parameters
sizeSize of the separable median filter in pixels. Must be an odd integer >= 3 (3, 5, 7, ...).

Definition at line 86 of file SeparableMedianFilter.h.

◆ SeparableMedianFilter() [2/2]

pcl::SeparableMedianFilter::SeparableMedianFilter ( const SeparableMedianFilter )
default

Copy constructor.

◆ ~SeparableMedianFilter()

pcl::SeparableMedianFilter::~SeparableMedianFilter ( )
inlineoverride

Destroys a SeparableMedianFilter object.

Definition at line 100 of file SeparableMedianFilter.h.

Member Function Documentation

◆ Apply() [1/5]

void pcl::SeparableMedianFilter::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::SeparableMedianFilter::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::SeparableMedianFilter::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::SeparableMedianFilter::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::SeparableMedianFilter::Apply ( pcl::UInt8Image image) const
overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ SetSize()

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

Sets a new size in pixels for this separable median filter object. The specified size must be an odd integer > 3 (3, 5, 7, ...).

Definition at line 116 of file SeparableMedianFilter.h.

◆ Size()

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

Returns the current size in pixels of this separable median filter.

Definition at line 107 of file SeparableMedianFilter.h.


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