PCL
pcl::AlphaTrimmedMeanFilter Class Reference

Alpha-trimmed mean operator. More...

#include <MorphologicalOperator.h>

+ Inheritance diagram for pcl::AlphaTrimmedMeanFilter:

Public Member Functions

 AlphaTrimmedMeanFilter ()=default
 
 AlphaTrimmedMeanFilter (float t)
 
 AlphaTrimmedMeanFilter (const AlphaTrimmedMeanFilter &)=default
 
MorphologicalOperatorClone () const override
 
String Description () const override
 
FloatPixelTraits::sample operator() (FloatPixelTraits::sample *f, size_type n) const override
 
DoublePixelTraits::sample operator() (DoublePixelTraits::sample *f, size_type n) const override
 
UInt8PixelTraits::sample operator() (UInt8PixelTraits::sample *f, size_type n) const override
 
UInt16PixelTraits::sample operator() (UInt16PixelTraits::sample *f, size_type n) const override
 
UInt32PixelTraits::sample operator() (UInt32PixelTraits::sample *f, size_type n) const override
 
void SetTrimmingFactor (float t)
 
float TrimmingFactor () const
 
- Public Member Functions inherited from pcl::MorphologicalOperator
 MorphologicalOperator ()=default
 
 MorphologicalOperator (const MorphologicalOperator &)=default
 
virtual ~MorphologicalOperator ()
 
virtual ComplexPixelTraits::sample operator() (ComplexPixelTraits::sample *f, size_type n) const
 
virtual DComplexPixelTraits::sample operator() (DComplexPixelTraits::sample *f, size_type n) const
 

Detailed Description

The alpha-trimmed mean operator computes the mean of the remaining values in a pixel neighborhood, after suppressing the d/2 lowest and the d/2 highest values. The point d defines the trimming factor of the operator. When d=0, we have an arithmetic mean filter. If d=1, the filter is the median operator.

The alpha-trimmed operator is not a morphological operator in the strict sense, although it allows for the implementation of robust filters that share some important properties with morphological filters in practical applications.

Definition at line 1478 of file MorphologicalOperator.h.

Constructor & Destructor Documentation

◆ AlphaTrimmedMeanFilter() [1/3]

pcl::AlphaTrimmedMeanFilter::AlphaTrimmedMeanFilter ( )
default

Default constructor. The default trimming factor is 0.2, which leads to the suppression of a 10% of the lowest and highest neighbor pixels. The resulting object is a robust mean filter resilient to outliers in most practical cases.

◆ AlphaTrimmedMeanFilter() [2/3]

pcl::AlphaTrimmedMeanFilter::AlphaTrimmedMeanFilter ( float  t)
inline

Constructs a AlphaTrimmedMeanFilter object with the specified trimming factor t in the [0,1] range.

Definition at line 1494 of file MorphologicalOperator.h.

◆ AlphaTrimmedMeanFilter() [3/3]

pcl::AlphaTrimmedMeanFilter::AlphaTrimmedMeanFilter ( const AlphaTrimmedMeanFilter )
default

Copy constructor.

Member Function Documentation

◆ Clone()

MorphologicalOperator* pcl::AlphaTrimmedMeanFilter::Clone ( ) const
inlineoverridevirtual

Returns a pointer to a dynamically allocated duplicate of this morphological operator.

Implements pcl::MorphologicalOperator.

Definition at line 1508 of file MorphologicalOperator.h.

◆ Description()

String pcl::AlphaTrimmedMeanFilter::Description ( ) const
inlineoverridevirtual

Returns a human-readable description of this morphological operator.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1532 of file MorphologicalOperator.h.

◆ operator()() [1/5]

FloatPixelTraits::sample pcl::AlphaTrimmedMeanFilter::operator() ( FloatPixelTraits::sample f,
size_type  n 
) const
inlineoverridevirtual

Applies this morphological operator to a vector f of n 32-bit floating point pixel samples.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1541 of file MorphologicalOperator.h.

◆ operator()() [2/5]

DoublePixelTraits::sample pcl::AlphaTrimmedMeanFilter::operator() ( DoublePixelTraits::sample f,
size_type  n 
) const
inlineoverridevirtual

Applies this morphological operator to a vector f of n 64-bit floating point pixel samples.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1550 of file MorphologicalOperator.h.

◆ operator()() [3/5]

UInt8PixelTraits::sample pcl::AlphaTrimmedMeanFilter::operator() ( UInt8PixelTraits::sample f,
size_type  n 
) const
inlineoverridevirtual

Applies this morphological operator to a vector f of n 8-bit unsigned integer pixel samples.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1559 of file MorphologicalOperator.h.

◆ operator()() [4/5]

UInt16PixelTraits::sample pcl::AlphaTrimmedMeanFilter::operator() ( UInt16PixelTraits::sample f,
size_type  n 
) const
inlineoverridevirtual

Applies this morphological operator to a vector f of n 16-bit unsigned integer pixel samples.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1568 of file MorphologicalOperator.h.

◆ operator()() [5/5]

UInt32PixelTraits::sample pcl::AlphaTrimmedMeanFilter::operator() ( UInt32PixelTraits::sample f,
size_type  n 
) const
inlineoverridevirtual

Applies this morphological operator to a vector f of n 32-bit unsigned integer pixel samples.

Reimplemented from pcl::MorphologicalOperator.

Definition at line 1577 of file MorphologicalOperator.h.

◆ SetTrimmingFactor()

void pcl::AlphaTrimmedMeanFilter::SetTrimmingFactor ( float  t)
inline

Sets the trimming factor t of this alpha-trimmed mean operator.

Definition at line 1524 of file MorphologicalOperator.h.

References pcl::Range().

◆ TrimmingFactor()

float pcl::AlphaTrimmedMeanFilter::TrimmingFactor ( ) const
inline

Returns the trimming factor of this alpha-trimmed mean operator.

Definition at line 1516 of file MorphologicalOperator.h.


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