dsp::IIR::Coefficients< NumericType > Struct Template Reference

A set of coefficients for use in an Filter object. More...

#include <juce_IIRFilter.h>

Inheritance diagram for dsp::IIR::Coefficients< NumericType >:

Public Types
using	Ptr = ReferenceCountedObjectPtr<Coefficients>
	The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one.
Public Types inherited from dsp::ProcessorState
using	Ptr = ReferenceCountedObjectPtr<ProcessorState>
	The ProcessorState structure is ref-counted, so this is a handy type that can be used as a pointer to one.

Public Member Functions
	Coefficients ()
	Creates a null set of coefficients (which will produce silence).
	Coefficients (NumericType b0, NumericType b1, NumericType a0, NumericType a1)
	Directly constructs an object from the raw coefficients.
	Coefficients (NumericType b0, NumericType b1, NumericType b2, NumericType a0, NumericType a1, NumericType a2)
	Coefficients (NumericType b0, NumericType b1, NumericType b2, NumericType b3, NumericType a0, NumericType a1, NumericType a2, NumericType a3)
	Coefficients (const Coefficients &)=default
	Coefficients (Coefficients &&)=default
Coefficients &	operator= (const Coefficients &)=default
Coefficients &	operator= (Coefficients &&)=default
template<size_t Num>
	Coefficients (const std::array< NumericType, Num > &values)
	Constructs from an array.
template<size_t Num>
Coefficients &	operator= (const std::array< NumericType, Num > &values)
	Assigns contents from an array.
size_t	getFilterOrder () const noexcept
	Returns the filter order associated with the coefficients.
double	getMagnitudeForFrequency (double frequency, double sampleRate) const noexcept
	Returns the magnitude frequency response of the filter for a given frequency and sample rate.
void	getMagnitudeForFrequencyArray (const double *frequencies, double *magnitudes, size_t numSamples, double sampleRate) const noexcept
	Returns the magnitude frequency response of the filter for a given frequency array and sample rate.
double	getPhaseForFrequency (double frequency, double sampleRate) const noexcept
	Returns the phase frequency response of the filter for a given frequency and sample rate.
void	getPhaseForFrequencyArray (double *frequencies, double *phases, size_t numSamples, double sampleRate) const noexcept
	Returns the phase frequency response of the filter for a given frequency array and sample rate.
NumericType *	getRawCoefficients () noexcept
	Returns a raw data pointer to the coefficients.
const NumericType *	getRawCoefficients () const noexcept
	Returns a raw data pointer to the coefficients.
Public Member Functions inherited from ReferenceCountedObject
void	incReferenceCount () noexcept
	Increments the object's reference count.
void	decReferenceCount () noexcept
	Decreases the object's reference count.
bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count.
int	getReferenceCount () const noexcept
	Returns the object's current reference count.

Static Public Member Functions
static Ptr	makeFirstOrderLowPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a first order low-pass filter.
static Ptr	makeFirstOrderHighPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a first order high-pass filter.
static Ptr	makeFirstOrderAllPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a first order all-pass filter.
static Ptr	makeLowPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a low-pass filter.
static Ptr	makeLowPass (double sampleRate, NumericType frequency, NumericType Q)
	Returns the coefficients for a low-pass filter with variable Q.
static Ptr	makeHighPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a high-pass filter.
static Ptr	makeHighPass (double sampleRate, NumericType frequency, NumericType Q)
	Returns the coefficients for a high-pass filter with variable Q.
static Ptr	makeBandPass (double sampleRate, NumericType frequency)
	Returns the coefficients for a band-pass filter.
static Ptr	makeBandPass (double sampleRate, NumericType frequency, NumericType Q)
	Returns the coefficients for a band-pass filter with variable Q.
static Ptr	makeNotch (double sampleRate, NumericType frequency)
	Returns the coefficients for a notch filter.
static Ptr	makeNotch (double sampleRate, NumericType frequency, NumericType Q)
	Returns the coefficients for a notch filter with variable Q.
static Ptr	makeAllPass (double sampleRate, NumericType frequency)
	Returns the coefficients for an all-pass filter.
static Ptr	makeAllPass (double sampleRate, NumericType frequency, NumericType Q)
	Returns the coefficients for an all-pass filter with variable Q.
static Ptr	makeLowShelf (double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor)
	Returns the coefficients for a low-pass shelf filter with variable Q and gain.
static Ptr	makeHighShelf (double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor)
	Returns the coefficients for a high-pass shelf filter with variable Q and gain.
static Ptr	makePeakFilter (double sampleRate, NumericType centreFrequency, NumericType Q, NumericType gainFactor)
	Returns the coefficients for a peak filter centred around a given frequency, with a variable Q and gain.

Public Attributes
Array< NumericType >	coefficients
	The raw coefficients.

Additional Inherited Members
Protected Member Functions inherited from ReferenceCountedObject
	ReferenceCountedObject ()=default
	Creates the reference-counted object (with an initial ref count of zero).
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
virtual	~ReferenceCountedObject ()
	Destructor.
void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object.

Detailed Description

template<typename NumericType>
struct dsp::IIR::Coefficients< NumericType >

A set of coefficients for use in an Filter object.

See also

IIR::Filter

Member Typedef Documentation

Ptr

template<typename NumericType >

using dsp::IIR::Coefficients< NumericType >::Ptr = ReferenceCountedObjectPtr<Coefficients>

The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one.

Constructor & Destructor Documentation

Coefficients() [1/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients

(

)

Creates a null set of coefficients (which will produce silence).

Coefficients() [2/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	a0,
		NumericType	a1 )

Directly constructs an object from the raw coefficients.

Most people will want to use the static methods instead of this, but the constructor is public to allow tinkerers to create their own custom filters!

Coefficients() [3/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	b2,
		NumericType	a0,
		NumericType	a1,
		NumericType	a2 )

Coefficients() [4/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	b2,
		NumericType	b3,
		NumericType	a0,
		NumericType	a1,
		NumericType	a2,
		NumericType	a3 )

Coefficients() [5/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients ( const Coefficients< NumericType > & )

default

Coefficients() [6/7]

template<typename NumericType >

dsp::IIR::Coefficients< NumericType >::Coefficients ( Coefficients< NumericType > && )

default

Coefficients() [7/7]

template<typename NumericType >

template<size_t Num>

dsp::IIR::Coefficients< NumericType >::Coefficients ( const std::array< NumericType, Num > & values )

explicit

Constructs from an array.

Member Function Documentation

operator=() [1/3]

template<typename NumericType >

Coefficients & dsp::IIR::Coefficients< NumericType >::operator= ( const Coefficients< NumericType > & )

default

operator=() [2/3]

template<typename NumericType >

Coefficients & dsp::IIR::Coefficients< NumericType >::operator= ( Coefficients< NumericType > && )

default

operator=() [3/3]

template<typename NumericType >

template<size_t Num>

Coefficients & dsp::IIR::Coefficients< NumericType >::operator=

(

const std::array< NumericType, Num > &

values

)

Assigns contents from an array.

makeFirstOrderLowPass()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeFirstOrderLowPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a first order low-pass filter.

makeFirstOrderHighPass()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeFirstOrderHighPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a first order high-pass filter.

makeFirstOrderAllPass()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeFirstOrderAllPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a first order all-pass filter.

makeLowPass() [1/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeLowPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a low-pass filter.

makeLowPass() [2/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeLowPass ( double sampleRate, NumericType frequency, NumericType Q )

static

Returns the coefficients for a low-pass filter with variable Q.

makeHighPass() [1/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeHighPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a high-pass filter.

makeHighPass() [2/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeHighPass ( double sampleRate, NumericType frequency, NumericType Q )

static

Returns the coefficients for a high-pass filter with variable Q.

makeBandPass() [1/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeBandPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a band-pass filter.

makeBandPass() [2/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeBandPass ( double sampleRate, NumericType frequency, NumericType Q )

static

Returns the coefficients for a band-pass filter with variable Q.

makeNotch() [1/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeNotch ( double sampleRate, NumericType frequency )

static

Returns the coefficients for a notch filter.

makeNotch() [2/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeNotch ( double sampleRate, NumericType frequency, NumericType Q )

static

Returns the coefficients for a notch filter with variable Q.

makeAllPass() [1/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeAllPass ( double sampleRate, NumericType frequency )

static

Returns the coefficients for an all-pass filter.

makeAllPass() [2/2]

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeAllPass ( double sampleRate, NumericType frequency, NumericType Q )

static

Returns the coefficients for an all-pass filter with variable Q.

makeLowShelf()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeLowShelf ( double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor )

static

Returns the coefficients for a low-pass shelf filter with variable Q and gain.

The gain is a scale factor that the low frequencies are multiplied by, so values greater than 1.0 will boost the low frequencies, values less than 1.0 will attenuate them.

makeHighShelf()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makeHighShelf ( double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor )

static

Returns the coefficients for a high-pass shelf filter with variable Q and gain.

The gain is a scale factor that the high frequencies are multiplied by, so values greater than 1.0 will boost the high frequencies, values less than 1.0 will attenuate them.

makePeakFilter()

template<typename NumericType >

static Ptr dsp::IIR::Coefficients< NumericType >::makePeakFilter ( double sampleRate, NumericType centreFrequency, NumericType Q, NumericType gainFactor )

static

Returns the coefficients for a peak filter centred around a given frequency, with a variable Q and gain.

The gain is a scale factor that the centre frequencies are multiplied by, so values greater than 1.0 will boost the centre frequencies, values less than 1.0 will attenuate them.

getFilterOrder()

template<typename NumericType >

size_t dsp::IIR::Coefficients< NumericType >::getFilterOrder ( ) const

noexcept

Returns the filter order associated with the coefficients.

getMagnitudeForFrequency()

template<typename NumericType >

double dsp::IIR::Coefficients< NumericType >::getMagnitudeForFrequency ( double frequency, double sampleRate ) const

noexcept

Returns the magnitude frequency response of the filter for a given frequency and sample rate.

getMagnitudeForFrequencyArray()

template<typename NumericType >

void dsp::IIR::Coefficients< NumericType >::getMagnitudeForFrequencyArray ( const double * frequencies, double * magnitudes, size_t numSamples, double sampleRate ) const

noexcept

Returns the magnitude frequency response of the filter for a given frequency array and sample rate.

getPhaseForFrequency()

template<typename NumericType >

double dsp::IIR::Coefficients< NumericType >::getPhaseForFrequency ( double frequency, double sampleRate ) const

noexcept

Returns the phase frequency response of the filter for a given frequency and sample rate.

getPhaseForFrequencyArray()

template<typename NumericType >

void dsp::IIR::Coefficients< NumericType >::getPhaseForFrequencyArray ( double * frequencies, double * phases, size_t numSamples, double sampleRate ) const

noexcept

Returns the phase frequency response of the filter for a given frequency array and sample rate.

getRawCoefficients() [1/2]

template<typename NumericType >

NumericType * dsp::IIR::Coefficients< NumericType >::getRawCoefficients ( )

noexcept

Returns a raw data pointer to the coefficients.

References dsp::IIR::Coefficients< NumericType >::coefficients, and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getRawDataPointer().

getRawCoefficients() [2/2]

template<typename NumericType >

const NumericType * dsp::IIR::Coefficients< NumericType >::getRawCoefficients ( ) const

noexcept

Returns a raw data pointer to the coefficients.

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin(), and dsp::IIR::Coefficients< NumericType >::coefficients.

Member Data Documentation

coefficients

template<typename NumericType >

Array<NumericType> dsp::IIR::Coefficients< NumericType >::coefficients

The raw coefficients.

You should leave these numbers alone unless you really know what you're doing.

Referenced by dsp::IIR::Coefficients< NumericType >::getRawCoefficients(), and dsp::IIR::Coefficients< NumericType >::getRawCoefficients().

---

The documentation for this struct was generated from the following file:

• juce_dsp/processors/juce_IIRFilter.h