Interactive FIR / IIR filter design GUI with a live magnitude / phase preview. More...

#include <filterdesignview.h>

Public Types
typedef QSharedPointer< FilterDesignView >	SPtr
typedef QSharedPointer< const FilterDesignView >	ConstSPtr
Public Types inherited from DISPLIB::AbstractView
enum	StyleMode { Default , Dark }
enum	GuiMode { Clinical , Research }
enum	ProcessingMode { RealTime , Offline }
typedef QSharedPointer< AbstractView >	SPtr
typedef QSharedPointer< const AbstractView >	ConstSPtr

Signals
void	filterChanged (const UTILSLIB::FilterKernel &activeFilter)
void	filterChannelTypeChanged (const QString &channelType)
void	updateFilterFrom (double dFrom)
void	updateFilterTo (double dTo)
Signals inherited from DISPLIB::AbstractView
void	guiStyleChanged (DISPLIB::AbstractView::StyleMode style)

Public Member Functions
	FilterDesignView (const QString &sSettingsPath, QWidget *parent=0, Qt::WindowFlags f=Qt::Widget)
	~FilterDesignView ()
void	setMaxAllowedFilterTaps (int iMaxNumberFilterTaps)
int	getFilterTaps ()
void	setSamplingRate (double dSamplingRate)
void	setFrom (double dFrom)
void	setTo (double dTo)
double	getFrom ()
double	getTo ()
UTILSLIB::FilterKernel	getCurrentFilter ()
QString	getChannelType ()
void	setChannelType (const QString &sType)
void	saveSettings ()
void	loadSettings ()
void	clearView ()
void	updateFilterPlot ()
void	guiStyleChanged (DISPLIB::AbstractView::StyleMode style)
Public Member Functions inherited from DISPLIB::AbstractView
	AbstractView (QWidget *parent=0, Qt::WindowFlags f=Qt::Widget)
virtual void	setGuiMode (GuiMode mode)
virtual void	setProcessingMode (ProcessingMode mode)

Protected Member Functions
void	updateGuiMode (GuiMode mode)
void	updateProcessingMode (ProcessingMode mode)
void	initSpinBoxes ()
void	initButtons ()
void	initComboBoxes ()
void	initFilterPlot ()
void	resizeEvent (QResizeEvent *event)
virtual void	keyPressEvent (QKeyEvent *event)
void	changeStateSpinBoxes (int currentIndex)
void	filterParametersChanged ()
void	onSpinBoxFilterChannelType (const QString &channelType)
void	onBtnExportFilterPlot ()
void	onBtnExportFilterCoefficients ()
void	onBtnLoadFilter ()
void	updateGuiFromFilter (const UTILSLIB::FilterKernel &filter)

Protected Attributes
std::unique_ptr< Ui::FilterDesignViewWidget >	m_pUi
QPointer< FilterPlotScene >	m_pFilterPlotScene
UTILSLIB::FilterKernel	m_filterKernel
QString	m_sSettingsPath
int	m_iFilterTaps
double	m_dSFreq
Protected Attributes inherited from DISPLIB::AbstractView
bool	m_bResearchModeIsActive
bool	m_bOfflineModeIsActive
QString	m_sSettingsPath

Detailed Description

Interactive FIR / IIR filter design GUI with a live magnitude / phase preview.

Lets the user pick filter type, design family (cosine, Hamming, Blackman, …), cutoff frequencies, transition bandwidth and tap count, then renders the resulting frequency response in an embedded FilterPlotScene and emits the FilterKernel as a filterChanged signal consumed by the rtprocessing chain.

Definition at line 84 of file filterdesignview.h.

Inheritance diagram for DISPLIB::FilterDesignView:

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const FilterDesignView> DISPLIB::FilterDesignView::ConstSPtr

Const shared pointer type for FilterDesignView.

Definition at line 90 of file filterdesignview.h.

◆ SPtr

typedef QSharedPointer<FilterDesignView> DISPLIB::FilterDesignView::SPtr

Shared pointer type for FilterDesignView.

Definition at line 89 of file filterdesignview.h.

Constructor & Destructor Documentation

◆ FilterDesignView()

FilterDesignView::FilterDesignView	(	const QString &	sSettingsPath,
		QWidget *	parent = 0,
		Qt::WindowFlags	f = Qt::Widget )

Constructs a FilterDesignView dialog which is a child of parent.

Parameters

[in]	sSettingsPath	Settings path under which the widget persists its state (empty = no persistence).
[in]	parent	pointer to parent widget; If parent is 0, the new FilterDesignView becomes a window. If parent is another widget, FilterDesignView becomes a child window inside parent. FilterDesignView is deleted when its parent is deleted.
[in]	f	Qt window flags passed to the QWidget constructor.

Definition at line 60 of file filterdesignview.cpp.

◆ ~FilterDesignView()

FilterDesignView::~FilterDesignView ( )

Destroys the FilterDesignView. All FilterDesignView's children are deleted first. The application exits if FilterDesignView is the main widget.

Definition at line 82 of file filterdesignview.cpp.

Member Function Documentation

◆ changeStateSpinBoxes()

void FilterDesignView::changeStateSpinBoxes ( int currentIndex )

protected

This function gets called whenever the combo box is altered by the user via the gui.

Parameters

[in] currentIndex holds the current index of the combo box.

Definition at line 357 of file filterdesignview.cpp.

◆ clearView()

void FilterDesignView::clearView ( )

virtual

Clears the view

Implements DISPLIB::AbstractView.

Definition at line 528 of file filterdesignview.cpp.

◆ filterChanged

void DISPLIB::FilterDesignView::filterChanged ( const UTILSLIB::FilterKernel & activeFilter )

signal

Emitted when the filter changes.

Parameters

[in] activeFilter The currently active filters.

◆ filterChannelTypeChanged

void DISPLIB::FilterDesignView::filterChannelTypeChanged ( const QString & channelType )

signal

Emitted when the filter channel type changed.

Parameters

[in] channelType The channel type on which the filter should be performed on.

◆ filterParametersChanged()

void FilterDesignView::filterParametersChanged ( )

protected

This function gets called whenever the filter parameters are altered by the user via the gui.

Definition at line 379 of file filterdesignview.cpp.

◆ getChannelType()

QString FilterDesignView::getChannelType ( )

Returns the current channel type which is to be filtered.

Returns: returns the channel type.

Definition at line 163 of file filterdesignview.cpp.

◆ getCurrentFilter()

FilterKernel FilterDesignView::getCurrentFilter ( )

Returns the current filter.

Returns: returns the current filter.

Definition at line 156 of file filterdesignview.cpp.

◆ getFilterTaps()

int FilterDesignView::getFilterTaps ( )

Returns the currently set number of filter taps.

Returns: returns the currently set number of filter taps.

Definition at line 104 of file filterdesignview.cpp.

◆ getFrom()

double FilterDesignView::getFrom ( )

Get filter 'From' value

Returns: filter 'From' value.

Definition at line 534 of file filterdesignview.cpp.

◆ getTo()

double FilterDesignView::getTo ( )

Get filter 'To' value

Returns: filter 'To' value.

Definition at line 541 of file filterdesignview.cpp.

◆ guiStyleChanged()

void FilterDesignView::guiStyleChanged ( DISPLIB::AbstractView::StyleMode style )

Process the event of style mode change in an upper class.

Parameters

[in] style New style mode (unused; the filter plot is simply redrawn).

Definition at line 560 of file filterdesignview.cpp.

◆ initButtons()

void FilterDesignView::initButtons ( )

protected

inits all buttons.

Definition at line 271 of file filterdesignview.cpp.

◆ initComboBoxes()

void FilterDesignView::initComboBoxes ( )

protected

inits the QComboBoxes.

Definition at line 285 of file filterdesignview.cpp.

◆ initFilterPlot()

void FilterDesignView::initFilterPlot ( )

protected

inits the filter plot.

Definition at line 310 of file filterdesignview.cpp.

◆ initSpinBoxes()

void FilterDesignView::initSpinBoxes ( )

protected

inits all spin boxes.

Definition at line 249 of file filterdesignview.cpp.

◆ keyPressEvent()

void FilterDesignView::keyPressEvent ( QKeyEvent * event )

protectedvirtual

keyPressEvent reimplemented virtual function to handle key events

Parameters

[in] event The key event; Enter/Return, Ctrl+Z and Delete re-emit the filter channel type.

Definition at line 331 of file filterdesignview.cpp.

◆ loadSettings()

void FilterDesignView::loadSettings ( )

virtual

Loads and inits all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 197 of file filterdesignview.cpp.

◆ onBtnExportFilterCoefficients()

void FilterDesignView::onBtnExportFilterCoefficients ( )

protected

This function exports the filter coefficients to a txt file.

Definition at line 480 of file filterdesignview.cpp.

◆ onBtnExportFilterPlot()

void FilterDesignView::onBtnExportFilterPlot ( )

protected

Saves an svg graphic of the scene if wanted by the user.

Definition at line 443 of file filterdesignview.cpp.

◆ onBtnLoadFilter()

void FilterDesignView::onBtnLoadFilter ( )

protected

This function loads a filter from a txt file.

Definition at line 501 of file filterdesignview.cpp.

◆ onSpinBoxFilterChannelType()

void FilterDesignView::onSpinBoxFilterChannelType ( const QString & channelType )

protected

This function applies the user defined filter to all channels.

Parameters

[in] channelType holds the current text of the connected spin box.

Definition at line 436 of file filterdesignview.cpp.

◆ resizeEvent()

void FilterDesignView::resizeEvent ( QResizeEvent * event )

protected

resizeEvent reimplemented virtual function to handle resize events of the filter window

Parameters

[in] event The resize event (unused; the plot is refitted to the view).

Definition at line 323 of file filterdesignview.cpp.

◆ saveSettings()

void FilterDesignView::saveSettings ( )

virtual

Saves all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 178 of file filterdesignview.cpp.

◆ setChannelType()

void FilterDesignView::setChannelType ( const QString & sType )

Sets the current channel type which is to be filtered.

Parameters

[in] sType The new channel type to be filtered.

Definition at line 170 of file filterdesignview.cpp.

◆ setFrom()

void FilterDesignView::setFrom ( double dFrom )

Sets filter 'From' value

Parameters

[in] dFrom set filter 'From' value.

Definition at line 140 of file filterdesignview.cpp.

◆ setMaxAllowedFilterTaps()

void FilterDesignView::setMaxAllowedFilterTaps ( int iMaxNumberFilterTaps )

Sets the max number of allowed filter taps.

Parameters

[in] iMaxNumberFilterTaps number of max allowed filter taps.

Definition at line 89 of file filterdesignview.cpp.

◆ setSamplingRate()

void FilterDesignView::setSamplingRate ( double dSamplingRate )

Sets the new samplingRate.

Parameters

[in] dSamplingRate the new sampling rate.

Definition at line 111 of file filterdesignview.cpp.

◆ setTo()

void FilterDesignView::setTo ( double dTo )

Sets filter 'To' value

Parameters

[in] dTo set filter 'To' value.

Definition at line 148 of file filterdesignview.cpp.

◆ updateFilterFrom

void DISPLIB::FilterDesignView::updateFilterFrom ( double dFrom )

signal

Update to simple filter control 'From'

Parameters

[in] dFrom change in filter 'From' value.

◆ updateFilterPlot()

void FilterDesignView::updateFilterPlot ( )

updates the filter plot scene with the newly generated filter

Definition at line 344 of file filterdesignview.cpp.

◆ updateFilterTo

void DISPLIB::FilterDesignView::updateFilterTo ( double dTo )

signal

Update to simple filter control 'To'

Parameters

[in] dTo change in filter 'To' value.

◆ updateGuiFromFilter()

void FilterDesignView::updateGuiFromFilter ( const UTILSLIB::FilterKernel & filter )

protected

Update Gui and filter based on an input filter parameters

Parameters

[in] filter filter which parameters will be used to update gui and stored filter.

Definition at line 548 of file filterdesignview.cpp.

◆ updateGuiMode()

void FilterDesignView::updateGuiMode ( GuiMode mode )

protectedvirtual

Update the views GUI based on the set GuiMode (Clinical=0, Research=1).

Parameters

[in] mode The new mode (Clinical=0, Research=1).

Implements DISPLIB::AbstractView.

Definition at line 225 of file filterdesignview.cpp.

◆ updateProcessingMode()

void FilterDesignView::updateProcessingMode ( ProcessingMode mode )

protectedvirtual

Update the views GUI based on the set ProcessingMode (RealTime=0, Offline=1).

Parameters

[in] mode The new mode (RealTime=0, Offline=1).

Implements DISPLIB::AbstractView.

Definition at line 237 of file filterdesignview.cpp.

Member Data Documentation

◆ m_dSFreq

double DISPLIB::FilterDesignView::m_dSFreq

protected

The current sampling frequency.

Definition at line 339 of file filterdesignview.h.

◆ m_filterKernel

UTILSLIB::FilterKernel DISPLIB::FilterDesignView::m_filterKernel

protected

The current filter operator.

Definition at line 334 of file filterdesignview.h.

◆ m_iFilterTaps

int DISPLIB::FilterDesignView::m_iFilterTaps

protected

The current number of filter taps.

Definition at line 338 of file filterdesignview.h.

◆ m_pFilterPlotScene

QPointer<FilterPlotScene> DISPLIB::FilterDesignView::m_pFilterPlotScene

protected

Pointer to the QGraphicsScene which holds the filter plotting.

Definition at line 332 of file filterdesignview.h.

◆ m_pUi

std::unique_ptr<Ui::FilterDesignViewWidget> DISPLIB::FilterDesignView::m_pUi

protected

Pointer to the qt designer generated ui class.

Definition at line 330 of file filterdesignview.h.

◆ m_sSettingsPath

QString DISPLIB::FilterDesignView::m_sSettingsPath

protected

The settings path to store the GUI settings to.

Definition at line 336 of file filterdesignview.h.

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

src/libraries/disp/viewers/filterdesignview.h
src/libraries/disp/viewers/filterdesignview.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ FilterDesignView()

◆ ~FilterDesignView()

Member Function Documentation

◆ changeStateSpinBoxes()

◆ clearView()

◆ filterChanged

◆ filterChannelTypeChanged

◆ filterParametersChanged()

◆ getChannelType()

◆ getCurrentFilter()

◆ getFilterTaps()

◆ getFrom()

◆ getTo()

◆ guiStyleChanged()

◆ initButtons()

◆ initComboBoxes()

◆ initFilterPlot()

◆ initSpinBoxes()

◆ keyPressEvent()

◆ loadSettings()

◆ onBtnExportFilterCoefficients()

◆ onBtnExportFilterPlot()

◆ onBtnLoadFilter()

◆ onSpinBoxFilterChannelType()

◆ resizeEvent()

◆ saveSettings()

◆ setChannelType()

◆ setFrom()

◆ setMaxAllowedFilterTaps()

◆ setSamplingRate()

◆ setTo()

◆ updateFilterFrom

◆ updateFilterPlot()

◆ updateFilterTo

◆ updateGuiFromFilter()

◆ updateGuiMode()

◆ updateProcessingMode()

Member Data Documentation

◆ m_dSFreq

◆ m_filterKernel

◆ m_iFilterTaps

◆ m_pFilterPlotScene

◆ m_pUi

◆ m_sSettingsPath