Kwave::NotchFilterDialog Class Reference

#include <NotchFilterDialog.h>

Inheritance diagram for Kwave::NotchFilterDialog:

Collaboration diagram for Kwave::NotchFilterDialog:

Signals
void	freqChanged (double freq)
void	bwChanged (double bw)
void	startPreListen ()
void	stopPreListen ()

Public Member Functions
	NotchFilterDialog (QWidget *parent, double sample_rate)
virtual	~NotchFilterDialog () Q_DECL_OVERRIDE
virtual QStringList	params () Q_DECL_OVERRIDE
virtual void	setParams (QStringList &params) Q_DECL_OVERRIDE
virtual QDialog *	dialog () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::PluginSetupDialog
virtual	~PluginSetupDialog ()

Protected Slots
void	freqValueChanged (int pos)
void	bwValueChanged (int pos)
void	listenToggled (bool listen)
void	listenStopped ()

Protected Member Functions
void	updateDisplay ()

Private Slots
void	invokeHelp ()

Private Attributes
double	m_frequency
double	m_bw
double	m_sample_rate
Kwave::NotchFilter *	m_filter

Detailed Description

Definition at line 36 of file NotchFilterDialog.h.

Constructor & Destructor Documentation

NotchFilterDialog()

Kwave::NotchFilterDialog::NotchFilterDialog	(	QWidget *	parent,
		double	sample_rate
	)

Constructor.

Parameters

parent	parent widget
sample_rate	sample rate of the audio data to be processed, needed for determining the allowed range of the cutoff frequency

Definition at line 42 of file NotchFilterDialog.cpp.

References bwValueChanged(), Kwave::connect(), freqValueChanged(), invokeHelp(), listenToggled(), m_bw, m_filter, m_frequency, Kwave::toInt(), and updateDisplay().

    :QDialog(parent), Kwave::PluginSetupDialog(),
     Ui::NotchFilterDlg(),
     m_frequency(3500),m_bw(100),
     m_sample_rate(sample_rate), m_filter(Q_NULLPTR)
{
    setupUi(this);
    setModal(true);

    // set maximum frequency to sample rate / 2
    double f_max = sample_rate / 2.0;

    slider->setMaximum(Kwave::toInt(f_max));
    spinbox->setMaximum(Kwave::toInt(f_max));

    slider_2->setMaximum(Kwave::toInt(f_max));
    spinbox_2->setMaximum(Kwave::toInt(f_max));

    // initialize the frequency scale widget
    scale_freq->setMinMax(0, Kwave::toInt(f_max));
    scale_freq->setLogMode(false);
    scale_freq->setUnit(i18n("Hz"));

    // initialize the attenuation scale widget
    scale_db->setMinMax(-24, +6);
    scale_db->setLogMode(false);
    scale_db->setUnit(i18n("dB"));

    // initialize the frequency response widget
    freq_response->init(f_max, -24, +6);

    // set up the low pass filter dunction
    m_filter = new NotchFilter();
    freq_response->setFilter(m_filter);

    // initialize the controls and the curve display
    slider->setValue(Kwave::toInt(m_frequency));
    spinbox->setValue(Kwave::toInt(m_frequency));
    slider_2->setValue(Kwave::toInt(m_bw));
    spinbox_2->setValue(Kwave::toInt(m_bw));
    updateDisplay();

    // changes in the slider or spinbox
    connect(spinbox, SIGNAL(valueChanged(int)),
            this, SLOT(freqValueChanged(int)));
    connect(spinbox_2, SIGNAL(valueChanged(int)),
            this, SLOT(bwValueChanged(int)));
    // click to the "Listen" button
    connect(btListen, SIGNAL(toggled(bool)),
            this, SLOT(listenToggled(bool)));

    // expand the "Listen" button to it's maximum width
    listenToggled(true);
    if (btListen->width() > btListen->minimumWidth())
        btListen->setMinimumWidth(btListen->width());
    listenToggled(false);
    if (btListen->width() > btListen->minimumWidth())
        btListen->setMinimumWidth(btListen->width());

    // set the initial size of the dialog
    int h = (width() * 3) / 5;
    if (height() < h) resize(width(), h);
    int w = (height() * 5) / 3;
    if (width() < w) resize(w, height());

    connect(buttonHelp->button(QDialogButtonBox::Help), SIGNAL(clicked()),
            this,   SLOT(invokeHelp()));

    // set the focus onto the "OK" button
    buttonBox->button(QDialogButtonBox::Ok)->setFocus();
}

Here is the call graph for this function:

~NotchFilterDialog()

Kwave::NotchFilterDialog::~NotchFilterDialog ( )

virtual

Destructor

Definition at line 115 of file NotchFilterDialog.cpp.

References listenToggled(), and m_filter.

{
    // better stop pre-listen now
    listenToggled(false);

    if (freq_response) freq_response->setFilter(Q_NULLPTR);
    if (m_filter) delete m_filter;
}

Here is the call graph for this function:

Member Function Documentation

bwChanged

void Kwave::NotchFilterDialog::bwChanged ( double  bw )

signal

Emitted when the bandwidth selectio has changed

Parameters

bw	the bandwidth parameter in Hz

Referenced by bwValueChanged(), and dialog().

Here is the caller graph for this function:

bwValueChanged

void Kwave::NotchFilterDialog::bwValueChanged ( int  pos )

protectedslot

called when the bw spinbox or slider value has changed

Definition at line 136 of file NotchFilterDialog.cpp.

References bwChanged(), m_bw, Kwave::toInt(), and updateDisplay().

Referenced by dialog(), and NotchFilterDialog().

{
    if (Kwave::toInt(m_bw) != pos) {
        m_bw = pos;
        updateDisplay();

        emit bwChanged(m_bw);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dialog()

virtual QDialog* Kwave::NotchFilterDialog::dialog ( )

inlinevirtual

retruns a pointer to this as a QDialog

Implements Kwave::PluginSetupDialog.

Definition at line 62 of file NotchFilterDialog.h.

References bwChanged(), bwValueChanged(), freqChanged(), freqValueChanged(), invokeHelp(), listenStopped(), listenToggled(), startPreListen(), stopPreListen(), and updateDisplay().

{ return this; }

Here is the call graph for this function:

freqChanged

void Kwave::NotchFilterDialog::freqChanged ( double  freq )

signal

Emitted whenever the frequency changes

Parameters

freq	the frequency parameter in Hz

Referenced by dialog(), and freqValueChanged().

Here is the caller graph for this function:

freqValueChanged

void Kwave::NotchFilterDialog::freqValueChanged ( int  pos )

protectedslot

called when the freq spinbox or slider value has changed

Definition at line 125 of file NotchFilterDialog.cpp.

References freqChanged(), m_frequency, Kwave::toInt(), and updateDisplay().

Referenced by dialog(), and NotchFilterDialog().

{
    if (Kwave::toInt(m_frequency) != pos) {
        m_frequency = pos;
        updateDisplay();

        emit freqChanged(m_frequency);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

invokeHelp

void Kwave::NotchFilterDialog::invokeHelp ( )

privateslot

invoke the online help

Definition at line 214 of file NotchFilterDialog.cpp.

References _.

Referenced by dialog(), and NotchFilterDialog().

{
    KHelpClient::invokeHelp(_("plugin_sect_notch_filter"));
}

Here is the caller graph for this function:

listenStopped

void Kwave::NotchFilterDialog::listenStopped ( )

protectedslot

called when the pre-listen mode stopped/aborted

Definition at line 207 of file NotchFilterDialog.cpp.

Referenced by dialog().

{
    if (btListen) btListen->setChecked(false);
}

Here is the caller graph for this function:

listenToggled

void Kwave::NotchFilterDialog::listenToggled ( bool  listen )

protectedslot

called when the "Listen" button has been toggled, to start or stop the pre-listen mode

Definition at line 190 of file NotchFilterDialog.cpp.

References startPreListen(), and stopPreListen().

Referenced by dialog(), NotchFilterDialog(), and ~NotchFilterDialog().

{
    Q_ASSERT(btListen);
    if (!btListen) return;

    if (listen) {
        // start pre-listen mode
        emit startPreListen();
        btListen->setText(i18n("&Stop"));
    } else {
        // stop pre-listen mode
        emit stopPreListen();
        btListen->setText(i18n("&Listen"));
    }
}

Here is the caller graph for this function:

params()

QStringList Kwave::NotchFilterDialog::params ( )

virtual

Returns the parameters as string list

Implements Kwave::PluginSetupDialog.

Definition at line 147 of file NotchFilterDialog.cpp.

References m_bw, and m_frequency.

{
    QStringList list;
    list << QString::number(m_frequency);
    list << QString::number(m_bw);
    return list;
}

setParams()

void Kwave::NotchFilterDialog::setParams ( QStringList &  params )

virtual

Sets the from a list of parameters

Implements Kwave::PluginSetupDialog.

Definition at line 156 of file NotchFilterDialog.cpp.

References m_bw, m_frequency, Kwave::toInt(), and updateDisplay().

{
    // evaluate the parameter list
    bool ok;
    double frequency = params[0].toDouble(&ok);
    Q_ASSERT(ok);
    if (ok) m_frequency = frequency;

    double bw = params[1].toDouble(&ok);
    Q_ASSERT(ok);
    if (ok) m_bw = bw;

    slider->setValue(Kwave::toInt(m_frequency));
    spinbox->setValue(Kwave::toInt(m_frequency));

    slider_2->setValue(Kwave::toInt(m_bw));
    spinbox_2->setValue(Kwave::toInt(m_bw));

    updateDisplay();
}

Here is the call graph for this function:

startPreListen

void Kwave::NotchFilterDialog::startPreListen ( )

signal

Pre-listen mode has been started

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

stopPreListen

void Kwave::NotchFilterDialog::stopPreListen ( )

signal

Pre-listen mode has been stopped

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

updateDisplay()

void Kwave::NotchFilterDialog::updateDisplay ( )

protected

Update the graphic display

Definition at line 178 of file NotchFilterDialog.cpp.

References m_bw, m_filter, m_frequency, m_sample_rate, Kwave::NotchFilter::setBandwidth(), and Kwave::NotchFilter::setFrequency().

Referenced by bwValueChanged(), dialog(), freqValueChanged(), NotchFilterDialog(), and setParams().

{
    double fs = m_sample_rate;
    if (m_filter && (fs > 0.0))
    {
        m_filter->setFrequency(QVariant(2.0 * M_PI * m_frequency / fs));
        m_filter->setBandwidth(QVariant(2.0 * M_PI * m_bw / fs));
        if (freq_response) freq_response->repaint();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_bw

double Kwave::NotchFilterDialog::m_bw

private

the bw in Hz

Definition at line 119 of file NotchFilterDialog.h.

Referenced by bwValueChanged(), NotchFilterDialog(), params(), setParams(), and updateDisplay().

m_filter

Kwave::NotchFilter* Kwave::NotchFilterDialog::m_filter

private

filter function for calculating the frequency response

Definition at line 125 of file NotchFilterDialog.h.

Referenced by NotchFilterDialog(), updateDisplay(), and ~NotchFilterDialog().

m_frequency

double Kwave::NotchFilterDialog::m_frequency

private

the cutoff frequency in Hz

Definition at line 116 of file NotchFilterDialog.h.

Referenced by freqValueChanged(), NotchFilterDialog(), params(), setParams(), and updateDisplay().

m_sample_rate

double Kwave::NotchFilterDialog::m_sample_rate

private

sample rate of the signal in samples/sec

Definition at line 122 of file NotchFilterDialog.h.

Referenced by updateDisplay().

---

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

• plugins/notch_filter/NotchFilterDialog.h
• plugins/notch_filter/NotchFilterDialog.cpp