#include <Resample.hh>

Inheritance diagram for Filters::ResampleBase:

Public Member Functions
virtual	~ResampleBase ()
	Destructor is virtual so that RTTI can be used. More...

int	getP () const
	Gets the resample numerator. More...

int	getQ () const
	Gets the resample numerator. More...

int	getN () const
	Gets anti-aliasing filter parameters. More...

int	getNOrder () const
	Gets anti-aliasing filter parameters. More...

double	getBeta () const
	Gets anti-aliasing filter parameters. More...

double	getDelay () const
	Gets the delay due to the filtering action. More...

virtual ResampleBase *	Clone () const =0
	Pure virtual constructor. More...

bool	operator== (const ResampleBase &rhs)
	Comparison operator. More...

virtual void	reset ()=0
	Reset the internal state to its initial condition. More...

virtual	~ResampleBase ()
	Destructor is virtual so that RTTI can be used. More...

int	getP () const
	Gets the resample numerator. More...

int	getQ () const
	Gets the resample numerator. More...

int	getN () const
	Gets anti-aliasing filter parameters. More...

int	getNOrder () const
	Gets anti-aliasing filter parameters. More...

double	getBeta () const
	Gets anti-aliasing filter parameters. More...

double	getDelay () const
	Gets the delay due to the filtering action. More...

virtual ResampleBase *	Clone () const =0
	Pure virtual constructor. More...

bool	operator== (const ResampleBase &rhs)
	Comparison operator. More...

virtual void	reset ()=0
	Reset the internal state to its initial condition. More...

virtual	~ResampleBase ()
	Destructor is virtual so that RTTI can be used. More...

int	getP () const
	Gets the resample numerator. More...

int	getQ () const
	Gets the resample numerator. More...

int	getN () const
	Gets anti-aliasing filter parameters. More...

int	getNOrder () const
	Gets anti-aliasing filter parameters. More...

double	getBeta () const
	Gets anti-aliasing filter parameters. More...

double	getDelay () const
	Gets the delay due to the filtering action. More...

virtual ResampleBase *	Clone () const =0
	Pure virtual constructor. More...

bool	operator== (const ResampleBase &rhs)
	Comparison operator. More...

virtual void	reset ()=0
	Reset the internal state to its initial condition. More...

Protected Member Functions
	ResampleBase (const int p, const int q, const int n, const double beta)
	General purpose constructor. More...

	ResampleBase (const int p, const int q)
	Special purpose constructor. More...

	ResampleBase (const int p, const int q, const int n, const double beta)
	General purpose constructor. More...

	ResampleBase (const int p, const int q)
	Special purpose constructor. More...

	ResampleBase (const int p, const int q, const int n, const double beta)
	General purpose constructor. More...

	ResampleBase (const int p, const int q)
	Special purpose constructor. More...

Private Member Functions
	ResampleBase ()
	Private default constructor, left undefined. More...

	ResampleBase ()
	Private default constructor, left undefined. More...

	ResampleBase ()
	Private default constructor, left undefined. More...

Private Attributes
int	m_p
	upsample factor More...

int	m_q
	downsample factor More...

int	m_n
	filter order parameter (not actual filter order) More...

int	m_nOrder
	anti-aliasing filter order More...

double	m_beta
	Kaiser window beta. More...

double	m_delay
	anti-aliasing filter group delay More...

Constructor & Destructor Documentation

◆ ~ResampleBase() [1/3]

Filters::ResampleBase::~ResampleBase ( )

virtual

Destructor is virtual so that RTTI can be used.

◆ ResampleBase() [1/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q,
		const int	n,
		const double	beta
	)

protected

General purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio
[in]	n	filter order: 2nmax(p, q) is the length of the filter
[in]	beta	the beta parameter of the Kaiser Window

Exceptions

invalid_argument if p or q or n < 1 or beta < 0.0

◆ ResampleBase() [2/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q
	)

protected

Special purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio

Exceptions

invalid_argument if p or q < 1

◆ ResampleBase() [3/9]

Filters::ResampleBase::ResampleBase ( )

private

Private default constructor, left undefined.

◆ ~ResampleBase() [2/3]

virtual Filters::ResampleBase::~ResampleBase ( )

virtual

Destructor is virtual so that RTTI can be used.

◆ ResampleBase() [4/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q,
		const int	n,
		const double	beta
	)

protected

General purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio
[in]	n	filter order: 2nmax(p, q) is the length of the filter
[in]	beta	the beta parameter of the Kaiser Window

Exceptions

invalid_argument if p or q or n < 1 or beta < 0.0

◆ ResampleBase() [5/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q
	)

protected

Special purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio

Exceptions

invalid_argument if p or q < 1

◆ ResampleBase() [6/9]

Filters::ResampleBase::ResampleBase ( )

private

Private default constructor, left undefined.

◆ ~ResampleBase() [3/3]

virtual Filters::ResampleBase::~ResampleBase ( )

virtual

Destructor is virtual so that RTTI can be used.

◆ ResampleBase() [7/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q,
		const int	n,
		const double	beta
	)

protected

General purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio
[in]	n	filter order: 2nmax(p, q) is the length of the filter
[in]	beta	the beta parameter of the Kaiser Window

Exceptions

invalid_argument if p or q or n < 1 or beta < 0.0

◆ ResampleBase() [8/9]

Filters::ResampleBase::ResampleBase	(	const int	p,
		const int	q
	)

protected

Special purpose constructor.

Parameters

[in]	p	upsampling ratio
[in]	q	downsampling ratio

Exceptions

invalid_argument if p or q < 1

◆ ResampleBase() [9/9]

Filters::ResampleBase::ResampleBase ( )

private

Private default constructor, left undefined.

Member Function Documentation

◆ Clone() [1/3]

virtual ResampleBase* Filters::ResampleBase::Clone ( ) const

pure virtual

Pure virtual constructor.

Returns: pointer to new ResampleBase object

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

◆ Clone() [2/3]

virtual ResampleBase* Filters::ResampleBase::Clone ( ) const

pure virtual

Pure virtual constructor.

Returns: pointer to new ResampleBase object

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

◆ Clone() [3/3]

virtual ResampleBase* Filters::ResampleBase::Clone ( ) const

pure virtual

Pure virtual constructor.

Returns: pointer to new ResampleBase object

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

◆ getBeta() [1/3]

double Filters::ResampleBase::getBeta ( ) const

Gets anti-aliasing filter parameters.

Returns: Kaiser Window beta parameter

◆ getBeta() [2/3]

double Filters::ResampleBase::getBeta ( ) const

Gets anti-aliasing filter parameters.

Returns: Kaiser Window beta parameter

◆ getBeta() [3/3]

double Filters::ResampleBase::getBeta ( ) const

Gets anti-aliasing filter parameters.

Returns: Kaiser Window beta parameter

◆ getDelay() [1/3]

double Filters::ResampleBase::getDelay ( ) const

Gets the delay due to the filtering action.

Returns: returns the group delay of the impulse due to filtering

◆ getDelay() [2/3]

double Filters::ResampleBase::getDelay ( ) const

Gets the delay due to the filtering action.

Returns: returns the group delay of the impulse due to filtering

Note: might need to be changed for general resampling

◆ getDelay() [3/3]

double Filters::ResampleBase::getDelay ( ) const

Gets the delay due to the filtering action.

Returns: returns the group delay of the impulse due to filtering

◆ getN() [1/3]

int Filters::ResampleBase::getN ( ) const

Gets anti-aliasing filter parameters.

Returns: filter length param

◆ getN() [2/3]

int Filters::ResampleBase::getN ( ) const

Gets anti-aliasing filter parameters.

Returns: filter length param

◆ getN() [3/3]

int Filters::ResampleBase::getN ( ) const

Gets anti-aliasing filter parameters.

Returns: filter length param

◆ getNOrder() [1/3]

int Filters::ResampleBase::getNOrder ( ) const

Gets anti-aliasing filter parameters.

Returns: filter order

◆ getNOrder() [2/3]

int Filters::ResampleBase::getNOrder ( ) const

Gets anti-aliasing filter parameters.

Returns: filter order

◆ getNOrder() [3/3]

int Filters::ResampleBase::getNOrder ( ) const

Gets anti-aliasing filter parameters.

Returns: filter order

◆ getP() [1/3]

int Filters::ResampleBase::getP ( ) const

Gets the resample numerator.

Returns: upsample factor

◆ getP() [2/3]

int Filters::ResampleBase::getP ( ) const

inline

Gets the resample numerator.

Returns: upsample factor

◆ getP() [3/3]

int Filters::ResampleBase::getP ( ) const

Gets the resample numerator.

Returns: upsample factor

◆ getQ() [1/3]

int Filters::ResampleBase::getQ ( ) const

Gets the resample numerator.

Returns: downsample factor

◆ getQ() [2/3]

int Filters::ResampleBase::getQ ( ) const

inline

Gets the resample numerator.

Returns: downsample factor

◆ getQ() [3/3]

int Filters::ResampleBase::getQ ( ) const

Gets the resample numerator.

Returns: downsample factor

◆ operator==() [1/3]

bool Filters::ResampleBase::operator== ( const ResampleBase & rhs )

Comparison operator.

Parameters

[in] rhs instance to be assigned from

Returns: true if data is the same, false otherwise

◆ operator==() [2/3]

bool Filters::ResampleBase::operator== ( const ResampleBase & rhs )

Comparison operator.

Parameters

[in] rhs instance to be assigned from

Returns: true if data is the same, false otherwise

◆ operator==() [3/3]

bool Filters::ResampleBase::operator== ( const ResampleBase & rhs )

Comparison operator.

Parameters

[in] rhs instance to be assigned from

Returns: true if data is the same, false otherwise

◆ reset() [1/3]

virtual void Filters::ResampleBase::reset ( )

pure virtual

Reset the internal state to its initial condition.

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

◆ reset() [2/3]

virtual void Filters::ResampleBase::reset ( )

pure virtual

Reset the internal state to its initial condition.

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

◆ reset() [3/3]

virtual void Filters::ResampleBase::reset ( )

pure virtual

Reset the internal state to its initial condition.

Implemented in Filters::Resample< TIn >, Filters::Resample< TIn >, and Filters::Resample< TIn >.

Member Data Documentation

◆ m_beta

double Filters::ResampleBase::m_beta

private

Kaiser window beta.

◆ m_delay

double Filters::ResampleBase::m_delay

private

anti-aliasing filter group delay

◆ m_n

int Filters::ResampleBase::m_n

private

filter order parameter (not actual filter order)

◆ m_nOrder

int Filters::ResampleBase::m_nOrder

private

anti-aliasing filter order

◆ m_p

int Filters::ResampleBase::m_p

private

upsample factor

◆ m_q

int Filters::ResampleBase::m_q

private

downsample factor

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

/build/ldas-tools-filters-2.6.6/debian/tmp/usr/include/filters/Resample.hh
/build/ldas-tools-filters-2.6.6/src/Resample.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ~ResampleBase() [1/3]

◆ ResampleBase() [1/9]

◆ ResampleBase() [2/9]

◆ ResampleBase() [3/9]

◆ ~ResampleBase() [2/3]

◆ ResampleBase() [4/9]

◆ ResampleBase() [5/9]

◆ ResampleBase() [6/9]

◆ ~ResampleBase() [3/3]

◆ ResampleBase() [7/9]

◆ ResampleBase() [8/9]

◆ ResampleBase() [9/9]

Member Function Documentation

◆ Clone() [1/3]

◆ Clone() [2/3]

◆ Clone() [3/3]

◆ getBeta() [1/3]

◆ getBeta() [2/3]

◆ getBeta() [3/3]

◆ getDelay() [1/3]

◆ getDelay() [2/3]

◆ getDelay() [3/3]

◆ getN() [1/3]

◆ getN() [2/3]

◆ getN() [3/3]

◆ getNOrder() [1/3]

◆ getNOrder() [2/3]

◆ getNOrder() [3/3]

◆ getP() [1/3]

◆ getP() [2/3]

◆ getP() [3/3]

◆ getQ() [1/3]

◆ getQ() [2/3]

◆ getQ() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

Member Data Documentation

◆ m_beta

◆ m_delay

◆ m_n

◆ m_nOrder

◆ m_p

◆ m_q