Controller that manages RtNoiseWorker for real-time noise spectrum estimation. More...

#include <rt_noise.h>

Public Types
typedef QSharedPointer< RtNoise >	SPtr
typedef QSharedPointer< const RtNoise >	ConstSPtr

Signals
void	SpecCalculated (const Eigen::MatrixXd &matSpecData)
void	operate (const Eigen::MatrixXd &matData)

Public Member Functions
	RtNoise (qint32 iFftLength, FIFFLIB::FiffInfo::SPtr pFiffInfo, qint32 iDataLength, QObject *parent=nullptr)
	~RtNoise ()
void	append (const Eigen::MatrixXd &matData)
bool	isRunning () const
bool	start ()
bool	stop ()
bool	wait (unsigned long time=ULONG_MAX)

Detailed Description

Controller that manages RtNoiseWorker for real-time noise spectrum estimation.

Definition at line 125 of file rt_noise.h.

Inheritance diagram for RTPROCESSINGLIB::RtNoise:

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const RtNoise> RTPROCESSINGLIB::RtNoise::ConstSPtr

Const shared pointer type for RtNoise.

Definition at line 131 of file rt_noise.h.

◆ SPtr

typedef QSharedPointer<RtNoise> RTPROCESSINGLIB::RtNoise::SPtr

Shared pointer type for RtNoise.

Definition at line 130 of file rt_noise.h.

Constructor & Destructor Documentation

◆ RtNoise()

RtNoise::RtNoise	(	qint32	iFftLength,
		FIFFLIB::FiffInfo::SPtr	pFiffInfo,
		qint32	iDataLength,
		QObject *	parent = nullptr )

explicit

Creates the real-time noise estimation object.

Parameters

[in]	iFftLength	Number of samples per FFT window.
[in]	pFiffInfo	Associated Fiff Information.
[in]	iDataLength	Number of blocks to accumulate before computing.
[in]	parent	Parent QObject (optional).

Definition at line 198 of file rt_noise.cpp.

◆ ~RtNoise()

RtNoise::~RtNoise ( )

Destroys the real-time noise estimation object.

Definition at line 219 of file rt_noise.cpp.

Member Function Documentation

◆ append()

void RtNoise::append ( const Eigen::MatrixXd & matData )

Submit incoming data for noise estimation.

Parameters

[in] matData Data block (channels x samples).

Definition at line 228 of file rt_noise.cpp.

◆ isRunning()

bool RtNoise::isRunning ( ) const

Returns whether the worker thread is running.

Definition at line 235 of file rt_noise.cpp.

◆ operate

void RTPROCESSINGLIB::RtNoise::operate ( const Eigen::MatrixXd & matData )

signal

Internal signal to forward data to the worker thread.

◆ SpecCalculated

void RTPROCESSINGLIB::RtNoise::SpecCalculated ( const Eigen::MatrixXd & matSpecData )

signal

Emitted when a new spectrum is available. Forwarded from the worker.

◆ start()

bool RtNoise::start ( )

Starts the worker thread.

Returns: true on success.

Definition at line 242 of file rt_noise.cpp.

◆ stop()

bool RtNoise::stop ( )

Stops the worker thread.

Returns: true on success.

Definition at line 255 of file rt_noise.cpp.

◆ wait()

bool RtNoise::wait ( unsigned long time = ULONG_MAX )

Blocks until the worker thread has finished, or until the timeout (ms) expires.

Definition at line 265 of file rt_noise.cpp.

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

src/libraries/dsp/rt/rt_noise.h
src/libraries/dsp/rt/rt_noise.cpp

Public Types

Signals

Public Member Functions