A class representing a Hann window. More...

#include <HannWindow.hh>

Inheritance diagram for Filters::HannWindow:

Public Member Functions
virtual std::string	name () const
	Return window name. More...

virtual double	param () const
	Return window parameter. More...

virtual HannWindow *	Clone () const
	Clone a window. More...

virtual std::string	name () const
	Return window name. More...

virtual double	param () const
	Return window parameter. More...

virtual HannWindow *	Clone () const
	Clone a window. More...

virtual std::string	name () const
	Return window name. More...

virtual double	param () const
	Return window parameter. More...

virtual HannWindow *	Clone () const
	Clone a window. More...

size_t	size () const
	Return window length. More...

size_t	size () const
	Return window length. More...

size_t	size () const
	Return window length. More...

double	mean () const
	Return mean value of window. More...

double	mean () const
	Return mean value of window. More...

double	mean () const
	Return mean value of window. More...

double	rms () const
	Return RMS value of window. More...

double	rms () const
	Return RMS value of window. More...

double	rms () const
	Return RMS value of window. More...

void	resize (const size_t n)
	Change the size of the window. More...

void	resize (const size_t n)
	Change the size of the window. More...

void	resize (const size_t n)
	Change the size of the window. More...

template<class T >
void	apply (std::valarray< T > &x)
	Apply a window to the data in-place. More...

template<class TOut , class TIn >
void	apply (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Apply a window to the data out-of-place. More...

template<class T >
void	apply (std::valarray< T > &x)
	Apply a window to the data in-place. More...

template<class TOut , class TIn >
void	apply (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Apply a window to the data out-of-place. More...

template<class T >
void	apply (std::valarray< T > &x)
	Apply a window to the data in-place. More...

template<class TOut , class TIn >
void	apply (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Apply a window to the data out-of-place. More...

template<class TOut , class TIn >
void	operator() (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Synonym for apply. More...

template<class TOut , class TIn >
void	operator() (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Synonym for apply. More...

template<class TOut , class TIn >
void	operator() (std::valarray< TOut > &out, const std::valarray< TIn > &in)
	Synonym for apply. More...

Protected Member Functions
void	populate ()
	Populate the elements of the window. More...

void	populate ()
	Populate the elements of the window. More...

void	populate ()
	Populate the elements of the window. More...

Private Member Functions
virtual double	element (const size_t i) const
	Get the ith element of the window. More...

virtual double	element (const size_t i) const
	Get the ith element of the window. More...

virtual double	element (const size_t i) const
	Get the ith element of the window. More...

Detailed Description

A class representing a Hann window.

Member Function Documentation

◆ apply() [1/6]

template<class T >

void Filters::Window::apply ( std::valarray< T > & x )

inherited

Apply a window to the data in-place.

Parameters

[in,out] x input/output sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ apply() [2/6]

template<class T >

void Filters::Window::apply ( std::valarray< T > & x )

inherited

Apply a window to the data in-place.

Parameters

[in,out] x input/output sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ apply() [3/6]

template<class T >

void Filters::Window::apply ( std::valarray< T > & x )

inherited

Apply a window to the data in-place.

Parameters

[in,out] x input/output sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ apply() [4/6]

template<class TOut , class TIn >

void Filters::Window::apply	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Apply a window to the data out-of-place.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ apply() [5/6]

template<class TOut , class TIn >

void Filters::Window::apply	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Apply a window to the data out-of-place.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ apply() [6/6]

template<class TOut , class TIn >

void Filters::Window::apply	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Apply a window to the data out-of-place.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ Clone() [1/3]

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

virtual

Clone a window.

Returns: copy of current window

Implements Filters::Window.

◆ Clone() [2/3]

HannWindow * Filters::HannWindow::Clone ( ) const

virtual

Clone a window.

Returns: copy of current window

Implements Filters::Window.

◆ Clone() [3/3]

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

virtual

Clone a window.

Returns: copy of current window

Implements Filters::Window.

◆ element() [1/3]

virtual double Filters::HannWindow::element ( const size_t i ) const

privatevirtual

Get the ith element of the window.

A Hann window is defined by

w[i] = 0.5*(1.0 - cos(2*LDAS_PI*i/(n-1)))

for i = 0,1, ... n-1

Note: the above definition of the Hann window is taken from "Discrete-time Signal Processing" by Oppenheim and Schafer, 2nd ed. p.468. This definition disagrees with that given in Matlab for hanning(n).

Parameters

[in] i the value at which the window is evaluated

Returns: the window element w[i]

Implements Filters::Window.

◆ element() [2/3]

double Filters::HannWindow::element ( const size_t i ) const

privatevirtual

Get the ith element of the window.

A Hann window is defined by

w[i] = 0.5*(1.0 - cos(2*LDAS_PI*i/(n-1)))

for i = 0,1, ... n-1

Note: the above definition of the Hann window is taken from "Discrete-time Signal Processing" by Oppenheim and Schafer, 2nd ed. p.468. This definition disagrees with that given in Matlab for hanning(n).

Parameters

[in] i the value at which the window is evaluated

Returns: the window element w[i]

Implements Filters::Window.

◆ element() [3/3]

virtual double Filters::HannWindow::element ( const size_t i ) const

privatevirtual

Get the ith element of the window.

A Hann window is defined by

w[i] = 0.5*(1.0 - cos(2*LDAS_PI*i/(n-1)))

for i = 0,1, ... n-1

Note: the above definition of the Hann window is taken from "Discrete-time Signal Processing" by Oppenheim and Schafer, 2nd ed. p.468. This definition disagrees with that given in Matlab for hanning(n).

Parameters

[in] i the value at which the window is evaluated

Returns: the window element w[i]

Implements Filters::Window.

◆ mean() [1/3]

double Filters::Window::mean ( ) const

inlineinherited

Return mean value of window.

Returns: mean value of window elements

◆ mean() [2/3]

double Filters::Window::mean ( ) const

inherited

Return mean value of window.

Returns: mean value of window elements

◆ mean() [3/3]

double Filters::Window::mean ( ) const

inherited

Return mean value of window.

Returns: mean value of window elements

◆ name() [1/3]

virtual std::string Filters::HannWindow::name ( ) const

virtual

Return window name.

Returns: window name

Implements Filters::Window.

◆ name() [2/3]

virtual std::string Filters::HannWindow::name ( ) const

virtual

Return window name.

Returns: window name

Implements Filters::Window.

◆ name() [3/3]

std::string Filters::HannWindow::name ( ) const

virtual

Return window name.

Returns: window name

Implements Filters::Window.

◆ operator()() [1/3]

template<class TOut , class TIn >

void Filters::Window::operator()	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Synonym for apply.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ operator()() [2/3]

template<class TOut , class TIn >

void Filters::Window::operator()	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Synonym for apply.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ operator()() [3/3]

template<class TOut , class TIn >

void Filters::Window::operator()	(	std::valarray< TOut > &	out,
		const std::valarray< TIn > &	in
	)

inherited

Synonym for apply.

Parameters

[out]	out	windowed sequence
[in]	in	input sequence

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for window

◆ param() [1/3]

virtual double Filters::HannWindow::param ( ) const

virtual

Return window parameter.

Returns: window parameter

Implements Filters::Window.

◆ param() [2/3]

virtual double Filters::HannWindow::param ( ) const

virtual

Return window parameter.

Returns: window parameter

Implements Filters::Window.

◆ param() [3/3]

double Filters::HannWindow::param ( ) const

virtual

Return window parameter.

Returns: window parameter

Implements Filters::Window.

◆ populate() [1/3]

void Filters::Window::populate ( )

protectedinherited

Populate the elements of the window.

This function will usually need to be called by a derived class whenever the the window is changed in any way which affects the element() function, such as when some window parameter is altered.

◆ populate() [2/3]

void Filters::Window::populate ( )

protectedinherited

Populate the elements of the window.

This function will usually need to be called by a derived class whenever the the window is changed in any way which affects the element() function, such as when some window parameter is altered.

◆ populate() [3/3]

void Filters::Window::populate ( )

protectedinherited

Populate the elements of the window.

This function will usually need to be called by a derived class whenever the the window is changed in any way which affects the element() function, such as when some window parameter is altered.

◆ resize() [1/3]

void Filters::Window::resize ( const size_t n )

inherited

Change the size of the window.

Parameters

[in] n desired length of window

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for the window

◆ resize() [2/3]

void Filters::Window::resize ( const size_t n )

inherited

Change the size of the window.

Parameters

[in] n desired length of window

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for the window

◆ resize() [3/3]

void Filters::Window::resize ( const size_t n )

inherited

Change the size of the window.

Parameters

[in] n desired length of window

Exceptions

std::length_error	thrown if desired window length is greater than maximum allowed value
std::bad_alloc	thrown if not able to allocate memory for the window

◆ rms() [1/3]

double Filters::Window::rms ( ) const

inherited

Return RMS value of window.

Returns: root mean square value of window elements

◆ rms() [2/3]

double Filters::Window::rms ( ) const

inherited

Return RMS value of window.

Returns: root mean square value of window elements

◆ rms() [3/3]

double Filters::Window::rms ( ) const

inlineinherited

Return RMS value of window.

Returns: root mean square value of window elements

◆ size() [1/3]

size_t Filters::Window::size ( ) const

inlineinherited

Return window length.

Returns: length of window

◆ size() [2/3]

size_t Filters::Window::size ( ) const

inherited

Return window length.

Returns: length of window

◆ size() [3/3]

size_t Filters::Window::size ( ) const

inherited

Return window length.

Returns: length of window

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ apply() [1/6]

◆ apply() [2/6]

◆ apply() [3/6]

◆ apply() [4/6]

◆ apply() [5/6]

◆ apply() [6/6]

◆ Clone() [1/3]

◆ Clone() [2/3]

◆ Clone() [3/3]

◆ element() [1/3]

◆ element() [2/3]

◆ element() [3/3]

◆ mean() [1/3]

◆ mean() [2/3]

◆ mean() [3/3]

◆ name() [1/3]

◆ name() [2/3]

◆ name() [3/3]

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ param() [1/3]

◆ param() [2/3]

◆ param() [3/3]

◆ populate() [1/3]

◆ populate() [2/3]

◆ populate() [3/3]

◆ resize() [1/3]

◆ resize() [2/3]

◆ resize() [3/3]

◆ rms() [1/3]

◆ rms() [2/3]

◆ rms() [3/3]

◆ size() [1/3]

◆ size() [2/3]

◆ size() [3/3]