Sample Class Reference

Transform a discrete time series. More...

#include <Sample.h>

Collaboration diagram for Sample:

Public Member Functions
bool	GetHighPassFrequency (void)
	Returns the current highpass frequency.
bool	GetNativeFrequency (void)
	Returns the current native sampling frequency.
bool	GetStatus (void)
	Returns current class status.
bool	GetWorkingFrequency (void)
	Returns the current working sampling frequency.
bool	SetFrequencies (const int aNativeFrequency, const int aWorkingFrequency, const double aHighPassFrequency=0)
	Defines frequencies for the transformation.
bool	SetHighPassFrequency (const double aHighPassFrequency)
	Defines a highpass frequency.
bool	SetNativeFrequency (const int aNativeFrequency)
	Sets a new native sampling frequency.
bool	SetWorkingFrequency (const int aWorkingFrequency)
	Sets a new working sampling frequency.
bool	Transform (const int invectorsize, double invector, const int outvectorsize, double outvector)
	Transforms data.
Constructors and destructors

	Sample (const int aVerbosity=0)
	Constructor of the Sample class.
virtual	~Sample (void)
	Destructor of the Sample class.
Protected Attributes
double	fHighPassFrequency
	cutoff frequency
int	fNativeFrequency
	native sampling frequency
int	fVerbosity
	verbosity level
int	fWorkingFrequency
	working sampling frequency
bool	status_OK
	class status flag

Detailed Description

Transform a discrete time series.

It includes:

resampling
frequency high-passing

Author:: Florent Robinet

Constructor & Destructor Documentation

Sample::Sample ( const int aVerbosity = 0 )

Constructor of the Sample class.

Parameters:

aVerbosity

verbosity level

Sample::~Sample ( void ) [virtual]

Destructor of the Sample class.

Member Function Documentation

bool Sample::GetHighPassFrequency ( void ) [inline]

Returns the current highpass frequency.

bool Sample::GetNativeFrequency ( void ) [inline]

Returns the current native sampling frequency.

bool Sample::GetStatus ( void ) [inline]

Returns current class status.

bool Sample::GetWorkingFrequency ( void ) [inline]

Returns the current working sampling frequency.

bool Sample::SetFrequencies	(	const int	aNativeFrequency,
		const int	aWorkingFrequency,
		const double	aHighPassFrequency = `0`
	)

Defines frequencies for the transformation.

It is possible to work with a sampling frequency smaller than the native frequency, often for performance reasons. This function sets a new working frequency. It must be an integer value and a power of 2. When transformed (see Transform()), the input data are first downsampled to the working frequency with an anti-aliasing filter.

In a second step, it is possible to highpass the data. This function defines a new highpass frequency. When transformed (see Transform()), the input data are highpass-filtered.

Parameters:

	aNativeFrequency	native sampling frequency [Hz]
	aWorkingFrequency	working sampling frequency [Hz]
	aHighPassFrequency	highpass frequency [Hz]

bool Sample::SetHighPassFrequency ( const double aHighPassFrequency )

Defines a highpass frequency.

It is possible to highpass the data. This function sets a new highpass frequency. When transformed (see Transform()), the input data are filtered.

This function can only be called if SetFrequencies() has been previously called and if the new highpass frequency is compatible with previous frequency settings.

Parameters:

aHighPassFrequency

highpass frequency [Hz]

bool Sample::SetNativeFrequency ( const int aNativeFrequency )

Sets a new native sampling frequency.

This function can only be called if SetFrequencies() has been previously called and if the new working sampling frequency is compatible with previous frequency settings.

Parameters:

aNativeFrequency

native sampling frequency [Hz]

bool Sample::SetWorkingFrequency ( const int aWorkingFrequency )

Sets a new working sampling frequency.

It is possible to work with a sampling frequency smaller than the native frequency, often for performance reasons. This function sets a new working frequency. It must be an integer value and a power of 2. When transformed (see Transform()), the input data are first downsampled to the working frequency with an anti-aliasing filter.

This function can only be called if SetFrequencies() has been previously called and if the new working sampling frequency is compatible with previous frequency settings.

Parameters:

aWorkingFrequency

working sampling frequency [Hz]

bool Sample::Transform	(	const int	invectorsize,
		double *	invector,
		const int	outvectorsize,
		double *	outvector
	)

Transforms data.

The input data vector (time-domain) is transformed as previously defined: see SetWorkingFrequency() and SetHighPassFrequency(). The input vector must have an integer duration. The memory for the output vector must be allocated with the right size before calling this function. No size check will be performed and the the data size provided by the user will be trusted.

IMPORTANT: the input vector can be altered in case of presampling. Do not use after calling this function.

Parameters:

	invectorsize	input vector size (in samples)
	invector	input data vector (time-domain)
	outvectorsize	output vector size (in samples)
	outvector	output data vector (time-domain)