MCL: mcl::DigitalFilter Class Reference

MCL

A C++ library mirroring some of the most common Matlab functions.

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages

#include <digitalfilter.h>

Inheritance diagram for mcl::DigitalFilter:

Public Member Functions
virtual void	Filter (const Real input_data, const Int num_samples, Real output_data) noexcept

void	FilterSerial (const Real input_data, const Int num_samples, Real output_data) noexcept

virtual Real	Filter (const Real input) noexcept=0

std::vector< Real >	Filter (const std::vector< Real > &input) noexcept

virtual void	Reset ()=0

virtual	~DigitalFilter ()

Detailed Description

Digital filter abstract class

Constructor & Destructor Documentation

virtual mcl::DigitalFilter::~DigitalFilter ( )

inlinevirtual

Member Function Documentation

virtual void mcl::DigitalFilter::Filter	(	const Real *	input_data,
		const Int	num_samples,
		Real *	output_data
	)

inlinevirtualnoexcept

Reimplemented in mcl::IdenticalFilter, mcl::GainFilter, and mcl::IirFilter.

virtual Real mcl::DigitalFilter::Filter ( const Real input )

pure virtualnoexcept

Returns the output of the filter for an input equal to input .

Implemented in mcl::IdenticalFilter, mcl::GainFilter, mcl::IirFilter, mcl::FirFilter, and mcl::MaxGradientFilter.

std::vector<Real> mcl::DigitalFilter::Filter ( const std::vector< Real > & input )

inlinenoexcept

Returns the output of the filter for an input signal equal to input.

void mcl::DigitalFilter::FilterSerial	(	const Real *	input_data,
		const Int	num_samples,
		Real *	output_data
	)

inlinenoexcept

virtual void mcl::DigitalFilter::Reset ( )

pure virtual

Resets the state of the filter

Implemented in mcl::IdenticalFilter, mcl::GainFilter, mcl::IirFilter, mcl::FirFilter, and mcl::MaxGradientFilter.

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

mcl/include/digitalfilter.h