Nsound::FilterBandPassFIR Class Reference

#include <Nsound/FilterBandPassFIR.h>

Inheritance diagram for Nsound::FilterBandPassFIR:

Public Member Functions
	FilterBandPassFIR (const float64 &sample_rate, uint32 kernel_size, const float64 &frequency_Hz_low, const float64 &frequency_Hz_high)
virtual	~FilterBandPassFIR ()
float64	getFrequencyLow () const
float64	getFrequencyHigh () const
AudioStream	filter (const AudioStream &x)
AudioStream	filter (const AudioStream &x, const float64 &low_frequencies, const float64 &high_frequencies)
AudioStream	filter (const AudioStream &x, const Buffer &low_frequencies, const Buffer &high_frequencies)
Buffer	filter (const Buffer &x)
Buffer	filter (const Buffer &x, const float64 &frequencies_Hz_low, const float64 &frequencies_Hz_high)
Buffer	filter (const Buffer &x, const Buffer &frequencies_Hz_low, const Buffer &frequencies_Hz_high)
virtual float64	filter (const float64 &x)
virtual float64	filter (const float64 &x, const float64 &frequency_Hz)
virtual float64	filter (const float64 &x, const float64 &frequency_Hz_low, const float64 &frequency_Hz_high)
void	plot (boolean show_fc=true, boolean show_phase=false)
void	reset ()
void	setRealtime (bool flag)
AudioStream	filter (const AudioStream &x, const float64 &frequency)
AudioStream	filter (const AudioStream &x, const Buffer &frequencies)
Buffer	filter (const Buffer &x, const float64 &frequency)
Buffer	filter (const Buffer &x, const Buffer &frequencies)
Buffer	getFrequencyAxis (const uint32 n_fft=8192)
Buffer	getFrequencyResponse (const uint32 n_fft=8192)
Buffer	getImpulseResponse (const uint32 n_samples=8192)
virtual uint32	getKernelSize () const
Buffer	getPhaseResponse ()
float64	getSampleRate () const
void	plot (boolean show_phase=false)

Protected Attributes
FilterLowPassFIR *	low_
FilterHighPassFIR *	high_
float64	sample_rate_
float64	two_pi_over_sample_rate_
float64	sample_time_
uint32	kernel_size_
bool	is_realtime_

Private Member Functions
	FilterBandPassFIR (const FilterBandPassFIR &copy)
FilterBandPassFIR &	operator= (const FilterBandPassFIR &rhs)

Detailed Description

Definition at line 47 of file FilterBandPassFIR.h.

Constructor & Destructor Documentation

FilterBandPassFIR::FilterBandPassFIR	(	const float64 &	sample_rate,
		uint32	kernel_size,
		const float64 &	frequency_Hz_low,
		const float64 &	frequency_Hz_high
	)

Definition at line 50 of file FilterBandPassFIR.cc.

References Nsound::Filter::kernel_size_.

    :
    Filter(sample_rate),
    low_(new FilterLowPassFIR(sample_rate, kernel_size, frequency_Hz_high)),
    high_(new FilterHighPassFIR(sample_rate, kernel_size, frequency_Hz_low))
{
    kernel_size_ = kernel_size * 2;
}

FilterBandPassFIR::~FilterBandPassFIR ( )

virtual

Definition at line 65 of file FilterBandPassFIR.cc.

References high_, and low_.

{
    delete low_;
    delete high_;
}

Nsound::FilterBandPassFIR::FilterBandPassFIR ( const FilterBandPassFIR &  copy )

inlineprivate

Definition at line 133 of file FilterBandPassFIR.h.

        :
        Filter(copy.sample_rate_),
        low_(NULL),
        high_(NULL)
    {
    };

Member Function Documentation

float64 FilterBandPassFIR::getFrequencyLow

(

)

const

Definition at line 73 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::getFrequency(), and high_.

{
    return high_->getFrequency();
}

float64 FilterBandPassFIR::getFrequencyHigh

(

)

const

Definition at line 80 of file FilterBandPassFIR.cc.

References Nsound::FilterLowPassFIR::getFrequency(), and low_.

{
    return low_->getFrequency();
}

AudioStream FilterBandPassFIR::filter

(

const AudioStream &

x

)

Definition at line 87 of file FilterBandPassFIR.cc.

References Nsound::Filter::filter().

Referenced by main().

{
    return Filter::filter(x);
}

AudioStream FilterBandPassFIR::filter	(	const AudioStream &	x,
		const float64 &	low_frequencies,
		const float64 &	high_frequencies
	)

Definition at line 94 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x, f_low), f_high);
}

AudioStream FilterBandPassFIR::filter	(	const AudioStream &	x,
		const Buffer &	low_frequencies,
		const Buffer &	high_frequencies
	)

Definition at line 101 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x,f_low), f_high);
}

Buffer FilterBandPassFIR::filter

(

const Buffer &

x

)

Definition at line 111 of file FilterBandPassFIR.cc.

References Nsound::Filter::filter().

{
    return Filter::filter(x);
}

Buffer FilterBandPassFIR::filter	(	const Buffer &	x,
		const float64 &	frequencies_Hz_low,
		const float64 &	frequencies_Hz_high
	)

Definition at line 118 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x,f_low), f_high);
}

Buffer FilterBandPassFIR::filter	(	const Buffer &	x,
		const Buffer &	frequencies_Hz_low,
		const Buffer &	frequencies_Hz_high
	)

Definition at line 125 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x, f_low), f_high);
}

float64 FilterBandPassFIR::filter ( const float64 &  x )

virtual

Implements Nsound::Filter.

Definition at line 135 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x));
};

float64 FilterBandPassFIR::filter ( const float64 &  x, const float64 &  frequency_Hz  )

virtual

Implements Nsound::Filter.

Definition at line 142 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x));
}

float64 FilterBandPassFIR::filter ( const float64 &  x, const float64 &  frequency_Hz_low, const float64 &  frequency_Hz_high  )

virtual

Definition at line 149 of file FilterBandPassFIR.cc.

References Nsound::FilterHighPassFIR::filter(), Nsound::FilterLowPassFIR::filter(), high_, and low_.

{
    return low_->filter(high_->filter(x, f_low), f_high);
}

void FilterBandPassFIR::plot	(	boolean	show_fc = true,
		boolean	show_phase = false
	)

Definition at line 159 of file FilterBandPassFIR.cc.

References Nsound::Plotter::axvline(), Nsound::FilterHighPassFIR::getFrequency(), Nsound::FilterLowPassFIR::getFrequency(), Nsound::Filter::getKernelSize(), high_, low_, Nsound::Filter::plot(), Nsound::Filter::sample_rate_, Nsound::Plotter::subplot(), and Nsound::Plotter::title().

Referenced by main().

{
    char title[128];
    sprintf(title,
        "Band Pass FIR Frequency Response\n"
        "order = %d, fl = %0.1f Hz, fl = %0.1f Hz, sr = %0.1f Hz",
        low_->getKernelSize() - 1,
        high_->getFrequency(),
        low_->getFrequency(),
        sample_rate_);

    Filter::plot(show_phase);

    Plotter pylab;

    uint32 n_rows = 1;

    if(show_phase)
    {
        n_rows = 2;
    }

    if(show_fc)
    {
        pylab.subplot(n_rows, 1, 1);

        pylab.axvline(low_->getFrequency(),  "color='red'");
        pylab.axvline(high_->getFrequency(), "color='red'");

        pylab.title(title);
    }
}

void FilterBandPassFIR::reset ( )

virtual

Resets interal history buffer and sets the cut off frequency to the one used at declaration.

Implements Nsound::Filter.

Definition at line 194 of file FilterBandPassFIR.cc.

References high_, low_, Nsound::FilterLowPassFIR::reset(), and Nsound::FilterHighPassFIR::reset().

{
    low_->reset();
    high_->reset();
}

FilterBandPassFIR& Nsound::FilterBandPassFIR::operator= ( const FilterBandPassFIR &  rhs )

inlineprivate

Definition at line 142 of file FilterBandPassFIR.h.

    {
        return *this;
    };

void Nsound::Filter::setRealtime ( bool  flag )

inlineinherited

Definition at line 57 of file Filter.h.

References Nsound::Filter::is_realtime_.

{is_realtime_ = flag;}

AudioStream Filter::filter ( const AudioStream &  x, const float64 &  frequency  )

inherited

Definition at line 76 of file Filter.cc.

References Nsound::Filter::filter(), Nsound::AudioStream::getNChannels(), Nsound::AudioStream::getSampleRate(), Nsound::Filter::is_realtime_, M_THROW, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    uint32 n_channels = x.getNChannels();

    if(is_realtime_ && n_channels > 1)
    {
        M_THROW("In real-time mode, a filter per audio channel must be used!");
    }

    AudioStream y(x.getSampleRate(), n_channels);

    for(uint32 channel = 0; channel < n_channels; ++channel)
    {
        y[channel] = filter(x[channel], frequency);
    }

    return y;
}

AudioStream Filter::filter ( const AudioStream &  x, const Buffer &  frequencies  )

inherited

Definition at line 99 of file Filter.cc.

References Nsound::Filter::filter(), Nsound::AudioStream::getNChannels(), Nsound::AudioStream::getSampleRate(), Nsound::Filter::is_realtime_, M_THROW, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    uint32 n_channels = x.getNChannels();

    if(is_realtime_ && n_channels > 1)
    {
        M_THROW("In real-time mode, a filter per audio channel must be used!");
    }

    AudioStream y(x.getSampleRate(), n_channels);

    for(uint32 channel = 0; channel < n_channels; ++channel)
    {
        y[channel] = filter(x[channel], frequency);
    }

    return y;
}

Buffer Filter::filter ( const Buffer &  x, const float64 &  frequency  )

inherited

Definition at line 140 of file Filter.cc.

References Nsound::Buffer::begin(), Nsound::Buffer::end(), Nsound::Filter::filter(), Nsound::Buffer::getLength(), Nsound::Filter::is_realtime_, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    Buffer::const_iterator itor = x.begin();
    Buffer::const_iterator end = x.end();

    Buffer y(x.getLength());

    while(itor != end)
    {
        y << filter(*itor, frequency);

        ++itor;
    }

    return y;
}

Buffer Filter::filter ( const Buffer &  x, const Buffer &  frequencies  )

inherited

Definition at line 161 of file Filter.cc.

References Nsound::Buffer::begin(), Nsound::Buffer::cbegin(), Nsound::Buffer::end(), Nsound::Filter::filter(), Nsound::Buffer::getLength(), Nsound::Filter::is_realtime_, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    Buffer::const_circular_iterator freq = frequencies.cbegin();

    Buffer::const_iterator itor = x.begin();
    Buffer::const_iterator end = x.end();

    Buffer y(x.getLength());

    while(itor != end)
    {
        y << filter(*itor, *freq);

        ++itor;
        ++freq;
    }

    return y;
}

Buffer Filter::getFrequencyAxis ( const uint32  n_fft = 8192 )

inherited

Definition at line 185 of file Filter.cc.

References Nsound::FFTransform::roundUp2(), and Nsound::Filter::sample_rate_.

Referenced by main(), Nsound::Filter::plot(), and Nsound::FilterIIR::savePlot().

{
    uint32 fft_chunk_size = FFTransform::roundUp2(
        static_cast<int32>(n_fft));

    uint32 n_samples = fft_chunk_size / 2 + 1;

    float64 f_step = (1.0 / (static_cast<float64>(fft_chunk_size) / 2.0))
                   * (sample_rate_ / 2.0);

    Buffer f_axis;

    float64 f = 0.0;

    for(uint32 i = 0; i < n_samples; ++i)
    {
        f_axis << f;
        f += f_step;
    }

    return f_axis;
};

Buffer Filter::getFrequencyResponse ( const uint32  n_fft = 8192 )

inherited

Definition at line 210 of file Filter.cc.

References Nsound::FFTransform::fft(), Nsound::Filter::getImpulseResponse(), and Nsound::Filter::sample_rate_.

Referenced by Nsound::FilterBandPassIIR::FilterBandPassIIR(), FilterLeastSquaresFIR_UnitTest(), Nsound::FilterIIR::getRMS(), main(), Nsound::Filter::plot(), and Nsound::FilterIIR::savePlot().

{
    FFTransform fft(sample_rate_);

//~    fft.setWindow(HANNING);

    FFTChunkVector vec;

    vec = fft.fft(getImpulseResponse(), n_fft);

    return vec[0].getMagnitude();
}

Buffer Filter::getImpulseResponse ( const uint32  n_samples = 8192 )

inherited

Definition at line 225 of file Filter.cc.

References Nsound::Filter::filter(), Nsound::Filter::is_realtime_, and Nsound::Filter::reset().

Referenced by Nsound::Filter::getFrequencyResponse(), Nsound::FilterHighPassFIR::getImpulseResponse(), Nsound::FilterLowPassFIR::getImpulseResponse(), Nsound::FilterLeastSquaresFIR::getImpulseResponse(), Nsound::FilterIIR::getImpulseResponse(), and Nsound::Filter::getPhaseResponse().

{
    if(!is_realtime_) reset();

    Buffer response(n_samples);

    response << filter(1.0);

    for(uint32 i = 1; i < n_samples; ++i)
    {
        response << filter(0.0);
    }

    if(!is_realtime_) reset();

    return response;
}

virtual uint32 Nsound::Filter::getKernelSize ( ) const

inlinevirtualinherited

Reimplemented in Nsound::FilterIIR, and Nsound::FilterTone.

Definition at line 96 of file Filter.h.

References Nsound::Filter::kernel_size_.

Referenced by Nsound::FilterBandPassIIR::FilterBandPassIIR(), plot(), Nsound::FilterBandPassIIR::plot(), and Nsound::FilterBandRejectIIR::plot().

{return kernel_size_;};

Buffer Filter::getPhaseResponse ( )

inherited

Definition at line 245 of file Filter.cc.

References Nsound::FFTransform::fft(), Nsound::Filter::getImpulseResponse(), Nsound::Buffer::getLength(), Nsound::Filter::sample_rate_, and Nsound::Buffer::subbuffer().

Referenced by Nsound::Filter::plot().

{
    uint32 n_samples = static_cast<uint32>(sample_rate_ * 2);

    FFTransform fft(n_samples);

    FFTChunkVector vec;

    vec = fft.fft(getImpulseResponse(), n_samples);

    Buffer phase = vec[0].getPhase();

    return phase.subbuffer(0, phase.getLength() / 2 + 1);
}

float64 Nsound::Filter::getSampleRate ( ) const

inlineinherited

Definition at line 102 of file Filter.h.

References Nsound::Filter::sample_rate_.

{ return sample_rate_; };

void Filter::plot ( boolean  show_phase = false )

inherited

Definition at line 262 of file Filter.cc.

References Nsound::Plotter::figure(), Nsound::Buffer::getdB(), Nsound::Filter::getFrequencyAxis(), Nsound::Filter::getFrequencyResponse(), Nsound::Buffer::getMax(), Nsound::Filter::getPhaseResponse(), Nsound::Plotter::plot(), Nsound::Plotter::subplot(), Nsound::Plotter::xlabel(), Nsound::Plotter::ylabel(), and Nsound::Plotter::ylim().

Referenced by main(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterPhaser::plot(), Nsound::FilterTone::plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterAllPass::plot(), Nsound::FilterBandPassVocoder::plot(), plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandPassIIR::plot(), Nsound::FilterBandRejectIIR::plot(), and Nsound::FilterParametricEqualizer::plot().

{
    Buffer x = getFrequencyAxis();
    Buffer fr = getFrequencyResponse().getdB();

    Plotter pylab;

    pylab.figure();

    uint32 n_rows = 1;
    uint32 n_cols = 1;

    if(show_phase)
    {
        n_rows = 2;
    }

    pylab.subplot(n_rows, n_cols, 1);

    // Frequency response
    pylab.plot(x,fr, "blue");

    pylab.xlabel("Frequency (Hz)");
    pylab.ylabel("Frequency Response (dB)");

    // Phase response
    if(show_phase)
    {
        pylab.subplot(n_rows, n_cols, 2);

        Buffer pr = getPhaseResponse().getdB();

        pylab.plot(x,pr);

        pylab.xlabel("Frequency (Hz)");
        pylab.ylabel("Phase Response (dB)");
    }

    float64 ymax = fr.getMax();
    float64 height = ymax - -60.0;

    pylab.ylim(-60.0, ymax + 0.05 * height);
}

Member Data Documentation

FilterLowPassFIR* Nsound::FilterBandPassFIR::low_

protected

Definition at line 128 of file FilterBandPassFIR.h.

Referenced by filter(), getFrequencyHigh(), plot(), reset(), and ~FilterBandPassFIR().

FilterHighPassFIR* Nsound::FilterBandPassFIR::high_

protected

Definition at line 129 of file FilterBandPassFIR.h.

Referenced by filter(), getFrequencyLow(), plot(), reset(), and ~FilterBandPassFIR().

float64 Nsound::Filter::sample_rate_

protectedinherited

Definition at line 113 of file Filter.h.

Referenced by Nsound::FilterPhaser::filter(), Nsound::FilterCombLowPassFeedback::filter(), Nsound::FilterDelay::filter(), Nsound::FilterAllPass::FilterAllPass(), Nsound::FilterCombLowPassFeedback::FilterCombLowPassFeedback(), Nsound::FilterDelay::FilterDelay(), Nsound::FilterFlanger::FilterFlanger(), Nsound::FilterPhaser::FilterPhaser(), Nsound::FilterSlinky::FilterSlinky(), Nsound::Filter::getFrequencyAxis(), Nsound::Filter::getFrequencyResponse(), Nsound::Filter::getPhaseResponse(), Nsound::Filter::getSampleRate(), Nsound::FilterStageIIR::makeIIRKernelHelper(), Nsound::FilterHighPassFIR::makeKernel(), Nsound::FilterStageIIR::makeKernel(), Nsound::FilterBandPassVocoder::makeKernel(), Nsound::FilterLeastSquaresFIR::makeKernel(), Nsound::FilterParametricEqualizer::makeKernel(), Nsound::FilterPhaser::operator=(), Nsound::FilterLeastSquaresFIR::operator=(), Nsound::FilterFlanger::operator=(), Nsound::FilterIIR::operator=(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterPhaser::plot(), Nsound::FilterTone::plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterAllPass::plot(), plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandRejectIIR::plot(), Nsound::FilterBandPassIIR::plot(), Nsound::FilterParametricEqualizer::plot(), Nsound::FilterLowPassIIR::setCutoff(), and Nsound::FilterLeastSquaresFIR::setWindow().

float64 Nsound::Filter::two_pi_over_sample_rate_

protectedinherited

Definition at line 114 of file Filter.h.

Referenced by Nsound::FilterTone::makeKernel(), Nsound::FilterLowPassFIR::makeKernel(), and Nsound::FilterParametricEqualizer::makeKernel().

float64 Nsound::Filter::sample_time_

protectedinherited

Definition at line 115 of file Filter.h.

Referenced by Nsound::FilterLowPassMoogVcf::_make_filter().

uint32 Nsound::Filter::kernel_size_

protectedinherited

Definition at line 116 of file Filter.h.

Referenced by Nsound::FilterLowPassFIR::filter(), Nsound::FilterLeastSquaresFIR::filter(), FilterBandPassFIR(), Nsound::FilterBandPassIIR::FilterBandPassIIR(), Nsound::FilterBandRejectIIR::FilterBandRejectIIR(), Nsound::FilterHighPassIIR::FilterHighPassIIR(), Nsound::FilterLeastSquaresFIR::FilterLeastSquaresFIR(), Nsound::FilterLowPassFIR::FilterLowPassFIR(), Nsound::FilterLowPassIIR::FilterLowPassIIR(), Nsound::FilterLeastSquaresFIR::getKernel(), Nsound::Filter::getKernelSize(), Nsound::FilterHighPassFIR::makeKernel(), Nsound::FilterLowPassFIR::makeKernel(), Nsound::FilterBandRejectFIR::makeKernel(), Nsound::FilterLeastSquaresFIR::makeKernel(), Nsound::FilterLeastSquaresFIR::operator=(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterLowPassFIR::reset(), Nsound::FilterHighPassFIR::reset(), Nsound::FilterLeastSquaresFIR::reset(), Nsound::FilterLeastSquaresFIR::setKernel(), Nsound::FilterLeastSquaresFIR::setWindow(), and Nsound::FilterHighPassFIR::spectraReversal_().

bool Nsound::Filter::is_realtime_

protectedinherited

Definition at line 118 of file Filter.h.

Referenced by Nsound::Filter::filter(), Nsound::FilterBandRejectIIR::filter(), Nsound::FilterBandRejectFIR::filter(), Nsound::Filter::getImpulseResponse(), and Nsound::Filter::setRealtime().

---

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

• Nsound/FilterBandPassFIR.h
• Nsound/FilterBandPassFIR.cc