MedianFilter Class Reference

#include <median_filter.h>

Public Member Functions
	MedianFilter (size_t windowWidth=3)
	A simple median filter implementation. More...
	MedianFilter (size_t windowWidth, float initVal)
	Constructs the median filter class. More...
	~MedianFilter ()
	Return pointer to median filter past values/window. More...
void	Fill (float val)
	Fill median filter array with a certain value. More...
size_t	GetWindowWidth ()
	Return median filter window width. More...
float	Filter (float newPoint)
	Add point to median filter and return filtered value. More...

Private Attributes
size_t	N
size_t	insertIndex
float *	dataPoints

Constructor & Destructor Documentation

MedianFilter() [1/2]

MedianFilter::MedianFilter

(

size_t

windowWidth = 3

)

A simple median filter implementation.

Used to smooth noisy signals. Constructs the median filter class. Specify the window size upon class initialization.

Parameters

windowWidth

Number of elements to use to compute the median, number of past data points to store.

MedianFilter() [2/2]

MedianFilter::MedianFilter	(	size_t	windowWidth,
		float	initVal
	)

Constructs the median filter class.

Specify the window size upon class initialization.

Parameters

windowWidth	Number of elements to use to compute the median, number of past data points to store.
initVal	Initial value to fill the median filter array with.

~MedianFilter()

MedianFilter::~MedianFilter

(

)

Return pointer to median filter past values/window.

Returns

Pointer to median filter past values/window.

Member Function Documentation

Fill()

void MedianFilter::Fill

(

float

val

)

Fill median filter array with a certain value.

Use this to initialize the filter!

Parameters

val	Value to fill the array with.

Filter()

float MedianFilter::Filter

(

float

newPoint

)

Add point to median filter and return filtered value.

Parameters

newPoint

Noisy point to filter.

Returns

Median-filtered value.

GetWindowWidth()

size_t MedianFilter::GetWindowWidth

(

)

Return median filter window width.

Returns

Median filter window width.

Member Data Documentation

dataPoints

float* MedianFilter::dataPoints

private

insertIndex

size_t MedianFilter::insertIndex

private

N

size_t MedianFilter::N

private

---

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

• include/filters/median_filter.h
• src/filters/median_filter.cpp